<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/sync_io/detail/native_socket_stream_impl.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li><li class="navelem"><a class="el" href="dir_00580eb0cf40d799755587f5d56ed1cf.html">sync_io</a></li><li class="navelem"><a class="el" href="dir_51213d4cdf375ab846ee07ea55bdba59.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">native_socket_stream_impl.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="sync__io_2detail_2native__socket__stream__impl_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="protocol__negotiator_8hpp.html">ipc/transport/protocol_negotiator.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="detail_2transport__fwd_8hpp.html">ipc/transport/detail/transport_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="sync__io_2native__socket__stream_8hpp.html">ipc/transport/sync_io/native_socket_stream.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="asio__local__stream__socket__fwd_8hpp.html">ipc/transport/asio_local_stream_socket_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="asio__local__stream__socket_8hpp.html">ipc/transport/asio_local_stream_socket.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &quot;<a class="code" href="timer__ev__emitter_8hpp.html">ipc/util/sync_io/detail/timer_ev_emitter.hpp</a>&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &quot;<a class="code" href="asio__waitable__native__hndl_8hpp.html">ipc/util/sync_io/asio_waitable_native_hndl.hpp</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;<a class="code" href="sync__io__fwd_8hpp.html">ipc/util/sync_io/sync_io_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &lt;cstddef&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="preprocessor">#include &lt;flow/util/blob.hpp&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="preprocessor">#include &lt;queue&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1sync__io.html">ipc::transport::sync_io</a></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>{</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"></span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment">/**</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * Internal, non-movable pImpl implementation of sync_io::Native_socket_stream class.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * In and of itself it would have been directly and publicly usable; however Native_socket_stream adds move semantics</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * which are essential to cooperation with sync_io::Native_socket_stream_acceptor and overall consistency with the rest</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * of ipc::transport API and, arguably, boost.asio API design.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> *</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * @see All discussion of the public API is in sync_io::Native_socket_stream doc header; that class forwards to this</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *      one.  All discussion of pImpl-related notions is also there.  See that doc header first please.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *      Then come back here.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * Impl design</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * -----------</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * ### Intro / history ###</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * In the past transport::Native_socket_stream was one monolithic thing and therefore was was not exactly easy</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * to understand as a unit.  It has since been split into this `sync_io`-pattern core (which, to be clear, may</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * well be useful in and of itself) and transport::Native_socket_stream built around it.  Due to this split,</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * the complexity is split too, and each part is really quite manageable.</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * To understand `*this`, the only real obstacle is grokking the `sync_io` pattern (see util::sync_io doc header).</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * We will not recap it here in any depth.  The essential idea, though, is that when `*this` internally needs to</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *   - async-read or async-write over `m_peer_socket` (the low-level transport); or</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *   - schedule a timer to fire in T time</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * we must express either operation in terms of an async-wait (outsourced to the `*this` user).</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * Namely:</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> *   - async-read/write = async-wait on FD for readable/writable (outsourced) + on active event, we nb-read/write.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *   - scheduling timer = with the help of util::sync_io::Timer_event_emitter, make it so that when it does fire,</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *     a certain FD is made readable; async-wait on FD for readable (outsourced) + on active event, we read</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *     to the firing.</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> *</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * Those are the building blocks.  Other than that, it&#39;s a matter of designating our 2 pipes and how each one&#39;s</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * algorithm works.  Both are async algorithms but expressed in terms of the above building blocks (in the</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * `sync_io` pattern).</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * Reminder: we do not deal with threads.  To summarize our thread safety guarantees:</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *   - there are none, on a given `*this`; except</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *   - once in PEER state, send-ops (including `(*on_active_ev_func)()` from `start_send_*_ops()`) are allowed to</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *     be invoked concurrently to receive-ops (including `(*on_active_ev_func)()` from `start_receive_*_ops()`).</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * To allow for the latter, the design is carefully split into 2 op-types; and the only data they ever touch</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * in common comprise `m_*peer_socket`.  This makes makes perfect sense: a Unix domain socket connection</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * is full-duplex but done over a single FD.  See Impl::m_peer_socket doc header regarding how we ensure</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * safe concurrency without sacrificing perf.  (Spoiler alert: a tiny and simple critical section w/r/t</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * `m_*peer_socket` only.)</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> * There is, also, NULL state, wherein one can sync_connect() et al.  This is separate from the other 2, in this case</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * preceding them entirely.  We will soon discuss each algorithm: connect-ops, send-ops, receive-ops (though</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * connect-ops is treated more as an afterthought at the end).  Before we can speak of send-ops and receive-ops</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * algorithms, we have to establish the substrate over which they operate: the protocol they speak.  Don&#39;t worry;</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * it is a simple protocol.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> *</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * Before even speaking of *that* more generally, there was this specific question to settle:</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * ### Shutting down individual-direction pipes ###</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * As required by the concepts, the out-pipe can be (arbitrarily preceding dtor call) ended via APIs</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * `*end_sending()`.  How is this internally implemented?  I (ygoldfel) faced a dilemma in</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * answering this question.  Initially I was tempted to use the `shutdown()` native/boost.asio `Peer_socket` call</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * which takes an argument `int how`, specifying which-direction pipe to shut down.  Eventually I decided against it,</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * because the exact semantics of `shutdown()` for stream UDS are rather unclear; vaguely speaking how they act is</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * documented mostly w/r/t to TCP sockets, not local (UDS) ones, and even assuming UDS act the same isn&#39;t great, since</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> * TCP involves an unreliable medium with FIN/ACK/etc., while stream UDS internally just reliably shuffles around bytes</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * in kernel memory.  It&#39;s possible to get straight answers by reading kernel code, but how portable/maintainable is</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * that?  Lastly, when using `shutdown()`, the signaling-other-side semantics are particularly unclear; e.g., if I</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * `shutdown(how=WRITE)`, will opposing peer get an &quot;EOF&quot; (connection gracefully closed)?  Possibly but does that imply</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> * the other side was also closed?  `EPIPE` is also involved (if closing reader -- N/A for us but...)... it&#39;s just</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * low-level-obscure and hairy.  (Color commentary: POSIX and Linux documented behavior doesn&#39;t have the formal</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * completeness that Boost docs do; and if it did it&#39;d still IMO (ygoldfel) be arguably less formally</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * considered in its design.)</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * Therefore I (ygoldfel) decided to instead to take full control of it by *not* using `shutdown()` and instead using</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * the following semantics/impl.  The semantics = inspired both by common sense and `man` page references to similar</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * behavior when using actual `shutdown()` on native stream UDS; but really the latter is a sanity-check on the former;</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * and the former is king.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *   - Two local flags, #m_snd_finished and a conceptual rcv_finished, which start `false` and can only be set to `true`</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> *     (1x).  (rcv_finished is really just for exposition; it is represented by the general condition wherein</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *     #m_rcv_pending_err_code stores a truthy `Error_code`.)</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> *   - If side A user does `*end_sending()`, this sets #m_snd_finished and sends a special very-short</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *     &quot;graceful half-duplex close&quot; message -- albeit in order after any actual user messages from</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *     preceding `send_*()` calls; side B receives this and sets its rcv_finished (assigns a particular</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> *     receives-finished `Error_code` to #m_rcv_pending_err_code).</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *     - #m_snd_finished means: Send-through any pending-to-be-sent user messages from `send_*()`; then</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> *       the graceful-close message; and any `send_*()` calls after `*end_sending()` are</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> *       an immediate error::Code::S_SENDS_FINISHED_CANNOT_SEND at best (though could be another error, if something</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *       else is detected... but to the user error=error and is probably to be treated the same).</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *   - If rcv_finished became true (due to the other side sending a graceful-close):</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *     - There will be no subsequent low-level data after that, by definition of how the protocol is designed, meaning</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> *       the other peer shouldn&#39;t send any more (as said a few bullet points ago).  On our side, though, we don&#39;t</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *       rely on that and simply stop reading, as on socket error.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *     - This condition will be emitted via the `async_receive_*()` completion handler like any other</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *       connection-ending error (in this case, via error::code::S_RECEIVES_FINISHED_CANNOT_RECEIVE; but for example</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *       `boost::asio::error::eof` is a graceful-UDS-close &quot;error&quot; and is conceptually very similar).</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * The required internal code does require some care; but the resulting semantic certainty and control are</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * IMO (ygoldfel) worth it.  Using `shutdown()` instead might seem easy, but I strongly suspect the pain of semantic</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> * uncertainty would make up for that many times over.</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * OK; we&#39;ve decided how to deal with pipe ending -- basically, graceful-close is a message we explicitly need to</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * encode when sending and understand when receiving -- so now we can get into the topic of the protocol.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> * ### Internal protocol design ###</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> * This is most natural to discuss from the sending perspective; the receiving perspective will flow naturally from</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> * that.  (We&#39;ll talk about send_native_handle() and async_receive_native_handle(); the `*_blob()` variants</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> * are mere degenerate versions of those.  We&#39;ll also talk of end_sending() as opposed to async_end_sending(),</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> * as the latter involves the same protocol -- only adding a way of signaling the local user about completion</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> * which is irrelevant here.)</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> * To summarize, overall, send_native_handle() takes a non-`null()` #Native_handle, a non-empty util::Blob_const</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> * (buffer), or both; call the two together (one of which may be null/empty) a *user message*.  The other side is to</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> * receive the entire *user message* unchanged and without re-ordering w/r/t other user messages from preceding or</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> * succeeding calls.  In addition, if user invokes end_sending(), the effect on the other side should be as if a special</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * (safely distinguished from normal user messages) user message was received indicating sending-direction pipe</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * closing by the user (via a particular #Error_code emitted to async_receive_native_handle() completion handler).</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> * Lastly auto_ping() mandates some kind of internal ping message which is to be ignored by the receiver other</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * than resetting any idle time engaged via idle_timer_run().</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> *</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * That describes the top layer on either side.  At the bottom (the low-level transport mechanism) is a local (Unix</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * domain) peer socket through which we can send things.  Briefly summarizing, it is capable of all of</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * the above essentially directly with the following important exceptions or caveats:</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> *   -# Stream UDS don&#39;t usually# implement message boundary preservation -- hence messages must be</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> *      encoded somehow in such a way as to indicate message boundaries (and decoded on the other side).</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> *      This is further complicated by the case when a native handle must also be sent together with the</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *      boundary-preserved blob.</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> *      - (#) `SOCK_STREAM` does not preserve message boundaries.  `SEQ_PACKET` is very similar, apparently, but *does*.</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> *        I (ygoldfel) decided against it due to a subjective feeling of &quot;baggage&quot;: it&#39;s Linux-only (not POSIX), rarely</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *        used, lightly documented, and apparently spiritually associated with the obscure SCTP protocol.  None of this</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> *        is fatal (that I know of) but does not seem worth it given that, ultimately, a couple of bytes to encode</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *        a length over `SOCK_STREAM` = both easy and of low perf cost.  (`SOCK_DGRAM` is not suitable, because we</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> *        require a connection-based model.)</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *   -# There is no# equivalent to the end_sending() (close-one-direction-but-not-the-other) feature</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *      natively -- hence it must be encoded somehow yet without accidentally clashing with a normal user message</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *      (some kind &quot;escaping&quot; or equivalent is needed).</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *      - (#) We avoid `shutdown(int how)` for the reasons detailed above.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *   -# There is no built-in ping message either.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * Here&#39;s the protocol to handle these:</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *   - Each user message (send_native_handle()) is represented, in the same order, by 1+ bytes and optionally</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *     a handle: all sent over stream UDS.  Suppose (at least for exposition) we support blobs of size up to 64KiB.</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *     The user message is then encoded as 1-2 *payloads* in this order:</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *     - Payload 1 (required): The *meta-length*, encoded as a native-endianness 2-byte number, indicating size</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *       of the meta-blob provided by the user; 0x0000 indicates no meta-blob.  Plus, byte 1 may be paired with</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> *       a native handle; or no such handle if user provided no handle.  Note that meta-length=0 means there</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> *       *must* be a handle; otherwise the user&#39;s sending nothing (not allowed by API).</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> *     - Payload 2 (present unless meta-length=0x0000): The user-provided meta-blob, with given meta-length, verbatim.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> *   - Graceful-close message (from end_sending()) is encoded as 1 *payload*:</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *     - Payload 1 (required): 2-byte number 0x0000; no native handle.  Note this doesn&#39;t conflict with the</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> *       above, since there 0x0000 implies there is a handle too.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> *   - Auto-ping message (from auto_ping()) is encoded as 1 *payload*:</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> *     - Payload 1 (required): 2-byte number 0xFFFF; no native handle.  Note this doesn&#39;t conflict with the</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> *       above, since the length 0xFFFF is not allowed (due to #S_MAX_META_BLOB_LENGTH excluding it).</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> *</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * Naturally if user doesn&#39;t end_sending() before the whole thing is destroyed, then there is no</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> * graceful-close message either.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> *</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * ### Outgoing-direction impl design ###</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> * At construction, or entry to PEER state, we get a connected #m_peer_socket; and then it&#39;s off to the races.</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * Every message, whether from `send_*()`, the periodic auto_ping() timer firing, or `*end_sending()`, translates</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> * into a series of 1+ *low-level payloads*: each low-level payload containing: 0-1 `Native_handle`s associated with</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> * the 1st byte of the following; and (&quot;the following&quot;) a contiguous location in memory (pointer + length) to send.</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * At steady state, we can simply attempt to nb-send each payload, in sequence.  Unless would-block is encountered --</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> * which should not occur often assuming good opposing-side behavior -- this will simply work.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> *</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> * If it does not -- would-block does occur -- then:</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> *   - Any unsent payload(s), headed potentially by a fragment of one of them (if one was partially sent), have</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> *     to be *copied* and *enqueued* on a pending-payloads queue.  This is Impl::m_snd_pending_payloads_q.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> *   - We initiate an async-wait on Impl::m_peer_socket becoming writable, executed via `sync_io` pattern.</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> *</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> * While this queue is not empty, any additional payloads (from the aforementioned sources -- `send_*()`, etc.)</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * that might be built go to the back of `m_snd_pending_payloads_q`.</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> * While in this would-block state (where that queue is not empty), we await the async-wait&#39;s completion.</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> * Once it does come in we just try to send off the payloads again, this time off the queue.  The sent stuff</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> * gets dequeued, if anything is left another async-wait is in order; etc.</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> *</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> * ### Incoming-direction impl design ###</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> * It is dealing with the in-pipe, which is independent of the out-pipe, with the exception of sharing the same</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> * handle (FD), `m_peer_socket`.  (We&#39;ve spoke of this already.  Just see `m_peer_socket` doc header.)</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> * To deal with it, operate based on what we know of our own out-pipe:</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> *</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> * The outgoing-direction algorithm is written to be agnostic as to what each low-level payload means:</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> * user messages (including graceful-close and auto-ping) are simply translated into &quot;1+&quot; payloads each, and then</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> * `m_snd_pending_payloads_q` just treats them as a sequence of payloads (it no longer matters how they came to be).</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> * However the incoming-direction algorithm does need to decode them back into the user messages that they</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> * originally meant.  To see how, just go back to the &quot;Internal protocol design&quot; above.  Each message starts with</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> * &quot;payload 1,&quot; which is also the only one that might contain a #Native_handle.  The payload 1 blob, always of length 2,</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> * is the &quot;meta-length&quot; field.  In exactly 1 scenario -- where it&#39;s neither 0 nor 0xFFFF -- is there payload 2 to</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> * read; and that one&#39;s length is the meta-length, and it is simply the entire meta-blob the sender sent.  In</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> * all other scenarios, there is no payload 2 -- the message is finalized; and it&#39;s off to the next one again.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> *</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> * So it&#39;s a state machine; not too exotic.  Read payload 1; if that&#39;s the whole message back to the start;</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> * otherwise read payload 2; back to the start; if error (including idle-timeout or graceful-close)</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> * then stop algorithm.</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment"> *</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"> * As in the Native_handle_receiver/Blob_receiver concepts at most 1 `async_receive_*()` is outstanding at a time,</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"> * that&#39;s all there is to the algorithm.  That said the code can get somewhat hairy, due to the difficulty of</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"> * expressing things that would&#39;ve been pretty simple with boost.asio, such as `boost::asio::async_read()`</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment"> * free function (which will read exactly N bytes, no less, unless error occurs).  We cannot do that stuff, as</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment"> * we have to issue async-waits to the user via `sync_io` pattern.  #Native_handle complicates it a bit more too.</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"> * That said all that stuff is tactical really.  Just see the code.</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"> *</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment"> * ### Connect-ops impl design ###</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment"> * The algorithm itself is easy enough to just follow in the code.  What is subtle however, we think, is why it is</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment"> * structured the way it is.  As per the public API of sync_io::Native_socket_stream (and the async-I/O-pattern</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment"> * counterpart transport::Native_socket_stream for that matter), there is only the one public API, sync_connect():</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment"> * it is non-blocking and synchronous, meaning it totally succeeds or fails immediately.  async_connect() and</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment"> * start_connect_ops() are `private`; replace_event_wait_handles() does not affect connect-ops.  Yet sync_connect()</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment"> * is written around those `private` facilities.  One, how is this even possible -- if there&#39;s (even internally)</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment"> * an async step, how can sync_connect() be synchronous yet non-blocking?  And two, supposing that is fine, then</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment"> * why write it this way -- as if following the `sync_io` pattern but entirely within the internal code of a `*this`?</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment"> *</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment"> * For the 1st question: First we quote the transport::Native_socket_stream public doc header which explains</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment"> * why there is only `sync_connect()` but no `async_connect()`:</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment"> * &quot;Without networking, the other side (Native_stream_socket_acceptor) either exists/is listening; or no.</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment"> * Connecting is a synchronous, non-blocking operation; so an `async_connect()` API in this context only makes</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment"> * life harder for the user.  (However, there are some serious plans to add a networking-capable counterpart</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment"> * (probably via TCP at least) to Native_socket_stream; that one will almost certainly have an `async_connect()`,</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment"> * while its `sync_connect()` will probably become potentially blocking.)&quot;  So that is why it works: internally</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment"> * with a Unix domain stream socket async-connect either immediately succeeds or fails in</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment"> * all situations, at least in Linux (as of this writing all that&#39;s supported).  (There are some further details</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment"> * inline in `async_connect()` impl.)  So internally it&#39;s simple to do a non-blocking sync-connect; return</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment"> * success/failure if not would-block; or async-wait for writability in the rare would-block situation; this too</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment"> * is resolved quickly, and we can internally use a future-promise pair to briefly-await that resolution inside</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment"> * sync_connect().</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment"> *</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment"> * That doesn&#39;t answer the 2nd question: Why is it written like this?  It would seem the code could be more compact</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment"> * if it were not written in the `sync_io`-pattern fashion, wherein we have a (`private`) start_connect_ops() and</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment"> * call it as-if we&#39;re an outside connect-ops user of sorts.  Answer: Truthfully, historically, I (ygoldfel)</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment"> * originally wrote it that way not really contemplating closely whether a local-socket connect-op can really</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment"> * take a blocking amount of time; and async_connect() *was* public.  Once I looked into it however, it became</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment"> * clear that it&#39;s always quick, which allowed various APIs -- all the way up to ipc::session::Session connect API --</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment"> * quite a bit more convenient to use.  At that point making only a public `sync_connect()` became a no-brainer.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment"> * However, while I did contemplate then cutting down that code to get rid of the `sync_io`-pattern structuring,</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment"> * I realized that over time this would only hurt us.  Why?  Answer: As we said publicly in the quote above,</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment"> * there probably *will* be a networked public `async_connect()`, and a huge % of the code in the</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment"> * networked-socket-stream class containing it will be reused from Native_socket_stream.  At that point</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment"> * the `sync_io`-pattern-based structuring will come in quite handy.  It&#39;s a subjective decision, undoubtedly, but</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment"> * I feel pretty good about it.  Also, it&#39;s really not all that much complex; after all the `sync_io` pattern</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment"> * is used all over the place including our own `*this` send-ops and receive-ops.</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment"> *</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment"> * ### Error handling ###</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment"> * See Impl::m_snd_pending_err_code and Impl::m_rcv_pending_err_code doc headers.  It&#39;s pretty simple:</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment"> * one that pipe is hosed, the appropriate one is set to truthy.  Now any user sending or receiving (whichever</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment"> * is applicable to the pipe) immediately yields that error.</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment"> *</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment"> * @todo Internal Native_socket_stream and Native_socket_stream_acceptor queue</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment"> * algorithms and data structures should be checked for RAM use; perhaps</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment"> * something should be periodically shrunk if applicable.  Look for `vector`s, `deque`s (including inside `queue`s).</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment"> *</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment"> * ### Protocol negotiation ###</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment"> * This adds a bit of stuff onto the above protocol.  It is very simple; please see Protocol_negotiator doc header;</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment"> * we use that convention.  Moreover, since this is the init version (version 1) of the protocol, we need not worry</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment"> * about speaking more than one version.  On the send side: All we do is send the version ahead of the first</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment"> * payload that would otherwise be sent for any reason (user message from `send_*()`, end-sending token from</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment"> * `*end_sending()`, or ping from auto_ping(), as of this writing), as a special message that is identical to</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment"> * a normal payload 1 (see above) whose contents are (instead of the usual length) the protocol version,</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment"> * namely the value `1`, meaning version 1.  Conversely on the receive side: we expect the first message received to be</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment"> * a native-handle-free paylod 1 with contents encoding a version number; then we let Protocol_negotiator</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment"> * do its thing in determining the protocol version spoken.</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment"> *</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment"> * @note It is very tempting to do that initial send in lazy fashion: meaning, about to send the first &quot;real&quot; payload?</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment"> *       OK, then pre-pend the negotiation message.  However this can create trouble in the future, if</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment"> *       a future protocol wants to be backwards-compatible (support more than 2 protocol versions): we&#39;ll need</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment"> *       to have received the opposing guy&#39;s preferred version, and thus determined which version to speak,</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment"> *       before sending further (non-negotiation) messages.  Bottom line... the initial send shall occur as soon</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment"> *       as we are operational (start_send_blob_ops()).</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment"> *</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment"> * After that, we just speak what we speak... which is the protocol&#39;s initial version -- as there is no other</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment"> * version for us.  (The opposing-side peer is responsible for closing the stream, if it is unable to speak version 1.)</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"> *</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment"> * If we do add protocol version 2, etc., in the future, then things *might* become somewhat more complex (but even</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment"> * then not necessarily so).  This is discussed in the `Protocol_negotiator m_protocol_negotiator` member doc header.</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment"> *</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment"> * @note We suggest that if version 2, etc., is/are added, then the above notes be kept more or less intact; then</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment"> *       add updates to show changes.  This will provide a good overview of how the protocol evolved; and our</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment"> *       backwards-compatibility story (even if we decide to have no backwards-compatibility).</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"> */</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html">  314</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html">Native_socket_stream::Impl</a> :</div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span>  <span class="keyword">public</span> flow::log::Log_context,</div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span>  <span class="keyword">private</span> boost::noncopyable <span class="comment">// And not movable.</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span>{</div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment"></span> </div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">  /// See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7b825476c04ea53eccea862d34f830c6">  322</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7b825476c04ea53eccea862d34f830c6">S_MAX_META_BLOB_LENGTH</a>;</div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span> </div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment"></span> </div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   * @param nickname_str</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   */</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae9194e2eefe81185d1bf067b1f934657">Impl</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> nickname_str);</div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment"></span> </div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   *</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   * @param native_peer_socket_moved</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   * @param nickname_str</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   */</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae9194e2eefe81185d1bf067b1f934657">Impl</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> nickname_str,</div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span>                <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>&amp;&amp; native_peer_socket_moved);</div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment"></span> </div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">  /// See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment"></span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#adeb067b178e7688dde0ca7c5eb877b1d">~Impl</a>();</div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span> </div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span> </div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span>  <span class="comment">/* Please see transport::Native_socket_stream::Impl::release() (also dead code) doc header; explains why this is</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * dead code but remains. */</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="preprocessor">#if 0</span><span class="comment"></span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * Key helper of Native_socket_stream::release(), this operates on a `*this` suitable for</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * `.release()` and makes it as-if no `start_*_ops()` or replace_event_wait_handles() have been called</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * since reaching PEER state.  In other words, if `start_send/receive_*_ops()` and/or `replace_event_wait_handles()`</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * have been called, they are undone.</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * Reminder: a `*this` is suitable for `.release()` if all of the following hold:</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *   - It is in PEER state.</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   *   - While in PEER state, none of the following have yet been called: `async_receive_*()`, `send_*()`,</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   *     `*end_sending()`, auto_ping(), idle_timer_run().</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   *</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   * In other words, it hasn&#39;t been used to transmit stuff in either direction.</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   *</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   * @note *Internally* in fact exactly one transmission may have occurred already: from `start_send_*_ops()` -- if</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * indeed it was called at least once -- protocol-negotiation out-message would have been sent.  That send might</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   * even have *failed*.  This impl handles all that properly (e.g., `start_send_*_ops()` after it returns will not</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   * try to re-send protocol-negotiation out-message which would cause chaos).</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   *</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   * Behavior is undefined (assertion may trip) if requirements above have not been met.</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   */</span><span class="preprocessor"></span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span>  <span class="keywordtype">void</span> reset_sync_io_setup();</div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment"></span> </div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   */</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span>  <span class="keyword">const</span> std::string&amp; <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ddd1b1e57bc61827d457e16e3db8600">nickname</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment"></span> </div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   *</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   * @param create_ev_wait_hndl_func</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   */</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a8b9839bb39e95a51ed7c920137438a21">replace_event_wait_handles</a></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span>         (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa455c7f045059736578ca275fc1a851f">Function</a>&lt;<a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Asio__waitable__native__handle.html">util::sync_io::Asio_waitable_native_handle</a> ()&gt;&amp; create_ev_wait_hndl_func);</div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment"></span> </div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   *</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   */</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span>  <a class="code hl_class" href="classipc_1_1util_1_1Process__credentials.html">util::Process_credentials</a> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6600090ca22c9b940155f7920b1465e4">remote_peer_process_credentials</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span> </div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span>  <span class="comment">// Connect-ops API.</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment"></span> </div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">   * @param absolute_name</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   */</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c5187e34876a0419ff70734ec0fbf14">sync_connect</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; absolute_name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span> </div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span>  <span class="comment">// Send-ops API.</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment"></span> </div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   */</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5fe9845081e656642a8b9f82f82228f6">send_meta_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment"></span> </div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   */</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#afa6b6e1be0f00add0b53b3263c412c76">send_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment"></span> </div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   *</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   */</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a65eea0cec146df598fce1d9ab5ce7e15">start_send_native_handle_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment"></span> </div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   *</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   */</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6a01d2df2772ee72e4386e84684394e3">start_send_blob_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment"></span> </div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   *</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   * @param hndl_or_null</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   * @param meta_blob</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment">   */</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a59e9935bdd704c40173a40e87b5db131">send_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> hndl_or_null, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; meta_blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment"></span> </div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   *</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   */</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aaef639c110a0e3d6804da84f9458ae78">send_blob</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment"></span> </div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   *</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   */</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0aca995c7150e72219b422c188d9bc23">async_end_sending</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, flow::async::Task_asio_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment"></span> </div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">  /// See Native_socket_stream counterpart.  @return Ditto.</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment"></span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aef7a604a32db50eaf5fc501e5a205dd3">end_sending</a>();</div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment"></span> </div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   *</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   * @param period</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   */</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab7b382067804495cbae180a5bc1a2757">auto_ping</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> period);</div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span> </div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span>  <span class="comment">// Receive-ops API.</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment"></span> </div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">   */</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#af5d6e9275386dfefddb7a97248b039a7">receive_meta_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment"></span> </div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   */</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ace12ebbb258f933e517255294f372795">receive_blob_max_size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment"></span> </div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="comment">   *</span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   */</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4a94088b9f00288ae7e2cf3c7b49c444">start_receive_native_handle_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment"></span> </div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   *</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">   */</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a12e99a2479fbf08b2fa32a2f17ed1ca7">start_receive_blob_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment"></span> </div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   *</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   * @param target_hndl</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   * @param target_meta_blob</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   */</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa3b06f1d59f5635c81a99e4ae8f7b8c7">async_receive_native_handle</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_hndl, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_meta_blob,</div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span>                                   <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz,</div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span>                                   flow::async::Task_asio_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment"></span> </div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   *</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   * @param target_blob</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   */</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4c3d1ba7c70649898a7893daf076c7ae">async_receive_blob</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_blob,</div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span>                          <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz,</div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span>                          flow::async::Task_asio_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span><span class="comment"></span> </div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">   * See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   *</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   * @param timeout</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   *        See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   * @return See Native_socket_stream counterpart.</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   */</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abedd0db5a5ae04e47085728ae548d07c">idle_timer_run</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> timeout);</div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span> </div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment"></span> </div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span><span class="comment">  /// Overall state of a Native_socket_stream::Impl.</span></div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9c9825f74472868eb1397c33edf78fb4">  576</a></span><span class="comment"></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9c9825f74472868eb1397c33edf78fb4">State</a></div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span><span class="comment">     * Not a peer.  Barring moves-from/moves-to: Possible initial state (via certain ctors); goes to CONNECTING</span></div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span><span class="comment">     * (via async_connect()).  Only async_connect() (via public sync_connect()) is possible in this state (other</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment">     * public methods tend to return immediately).</span></div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">     */</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span>    S_NULL,</div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment"></span> </div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">     * Not a peer but async_connect() in progress to try to make it a peer.  Barring moves-from/moves-to:</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">     * Entry from NULL; goes to PEER or NULL.</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">     */</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span>    S_CONNECTING,</div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment"></span> </div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">     * Is or was a connected peer.  Barring moves-from/moves-to:</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span><span class="comment">     * Possible initial state (via certain ctors); entry from CONNECTING; does not transition to any other state</span></div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span><span class="comment">     * (once a PEER, always a PEER).  async_connect() is not possible in this state (it returns immediately); other</span></div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment">     * public methods are possible.</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">     */</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span>    S_PEER</div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span>  }; <span class="comment">// enum class State</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment"></span> </div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   * Data store representing a payload corresponding to exactly one attempted async write-op, albeit</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   * used if and only if we encounter would-block in `send_*()` or snd_on_ev_auto_ping_now_timer_fired()</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   * or `*end_sending()` and have to queue (and therefore one-time-copy) data in #m_snd_pending_payloads_q.</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   *</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   * Note this does *not* represent an original user message given to Native_socket_stream::send_native_handle()</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   * but rather a low-level payload per the protocol described in the impl section of class</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   * doc header (payload 1, payload 2 if applicable).  We store them in queue via #Ptr.</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   */</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html">  609</a></span>  <span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html">Snd_low_lvl_payload</a></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span>  {</div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span>    <span class="comment">// Types.</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment"></span> </div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">    /// Short-hand for `unique_ptr` to this.</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35">  614</a></span><span class="comment"></span>    <span class="keyword">using </span><a class="code hl_typedef" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35">Ptr</a> = boost::movelib::unique_ptr&lt;Snd_low_lvl_payload&gt;;</div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span> </div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment"></span> </div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">    /// The native handle to transmit in the payload; `.null() == true` to transmit no such thing.</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a1896eff734a019cec47970cc081482e8">  619</a></span><span class="comment"></span>    <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> <a class="code hl_variable" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a1896eff734a019cec47970cc081482e8">m_hndl_or_null</a>;</div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment"></span> </div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">     * The buffer to transmit in the payload; `!m_blob.empty() == true`, period.  Note that this is the actual buffer</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">     * and not a mere location/size of an existing blob somewhere.</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="comment">     */</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#abd7b83c53f0bc04c6c74315f1bbe09d6">  625</a></span>    flow::util::Blob <a class="code hl_variable" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#abd7b83c53f0bc04c6c74315f1bbe09d6">m_blob</a>;</div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span>  }; <span class="comment">// struct Snd_low_lvl_payload</span></div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span><span class="comment"></span> </div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment">   * Identical to sync_io::Async_adapter_receiver::User_request, except we only keep at most 1 of these</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">   * and thus don&#39;t need a `Ptr` alias inside.  As in that other class, this records the args from an</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span><span class="comment">   * async_receive_native_handle() or async_receive_blob() call.</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span><span class="comment">   */</span></div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html">  633</a></span>  <span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html">Rcv_user_request</a></div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span>  {</div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="comment"></span> </div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span><span class="comment">    /// Same as in sync_io::Async_adapter_receiver::User_request.</span></div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#ae8094bf28837a5ff2f5794222114d3b7">  638</a></span><span class="comment"></span>    <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* <a class="code hl_variable" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#ae8094bf28837a5ff2f5794222114d3b7">m_target_hndl_ptr</a>;<span class="comment"></span></div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">    /// Same as in sync_io::Async_adapter_receiver::User_request.</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#a589c41dcf6cf1622c8df6a02e1f7497b">  640</a></span><span class="comment"></span>    <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a> <a class="code hl_variable" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#a589c41dcf6cf1622c8df6a02e1f7497b">m_target_meta_blob</a>;<span class="comment"></span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span><span class="comment">    /// Same as in sync_io::Async_adapter_receiver::User_request.</span></div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno"><a class="line" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#aefe91c059a20b86e2391bb1b46a38b23">  642</a></span><span class="comment"></span>    flow::async::Task_asio_err_sz <a class="code hl_variable" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#aefe91c059a20b86e2391bb1b46a38b23">m_on_done_func</a>;</div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span>  }; <span class="comment">// struct Rcv_user_request</span></div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="comment"></span> </div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span><span class="comment">   * Used to organize tje incoming-direction state machine tactically, this indicates what part of payload 1</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span><span class="comment">   * (&quot;head payload,&quot; mandatory) or payload 2 (&quot;meta-blob payload,&quot; optional) we are currently reading, based</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span><span class="comment">   * on the next byte to be read.  Relevant only if #m_rcv_user_request is not null (an async-receive is in progress).</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span><span class="comment">   */</span></div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0e765fbfee2c76293b572b01c9be5680">  650</a></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0e765fbfee2c76293b572b01c9be5680">Rcv_msg_state</a></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">    /// Reading start of payload 1: already have nothing -- no #Native_handle; no 1st byte.</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment"></span>    S_MSG_START,</div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment"></span> </div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">     * Reading payload 1, but at least byte 2: alreadu have at least byte 1 and either the #Native_handle or its lack.</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">     * At least 1 more byte, of `sizeof(m_rcv_target_meta_length)`, is remaining.  (As of this writing -- that</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">     * `sizeof()` is 2... so in fact in this state exactly 1 byte remains.  No need to rely on that in code though.)</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">     */</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span>    S_HEAD_PAYLOAD,</div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment"></span> </div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span><span class="comment">     * Reading payload 2; M bytes remain, where M is in [1, N], and N is the meta-length encoded in preceding</span></div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><span class="comment">     * payload 1.</span></div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span><span class="comment">     */</span></div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span>    S_META_BLOB_PAYLOAD</div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span>  }; <span class="comment">// enum class Rcv_msg_state</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span><span class="comment"></span> </div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">   * Compile-time tagging enumeration identifying the op-type of a given `sync_io` activity.</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><span class="comment">   * We use it to save on boiler-plate code which is almost identical regardless of the op-type in question.</span></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span><span class="comment">   * `if constexpr()`, etc.</span></div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="comment">   */</span></div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ac5471d1f4f7cad2aeb239b5f458f12f2">  674</a></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ac5471d1f4f7cad2aeb239b5f458f12f2">Op</a></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span>  {</div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span>    <span class="comment">// Send-ops, as started via `start_send_*_ops()`.</span></div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span>    S_SND,</div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span>    <span class="comment">// Receive-ops, as started via `start_receive_*_ops()`.</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span>    S_RCV,</div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span>    <span class="comment">// Connect-ops, as started via start_connect_ops().</span></div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span>    S_CONN</div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span>  };</div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span><span class="comment"></span> </div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span><span class="comment">  /// The type used to encode the meta-blob length; this puts a cap on how long the meta-blobs can be.</span></div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a881c376f1ee37f9b1a20f770824f55d9">  685</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a881c376f1ee37f9b1a20f770824f55d9">low_lvl_payload_blob_length_t</a> = uint16_t;</div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span>  <span class="keyword">static_assert</span>(std::numeric_limits&lt;low_lvl_payload_blob_length_t&gt;::is_integer</div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span>                  &amp;&amp; (!std::numeric_limits&lt;low_lvl_payload_blob_length_t&gt;::is_signed),</div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span>                <span class="stringliteral">&quot;low_lvl_payload_blob_length_t is a length type, so it must be an unsigned integer of some kind.&quot;</span>);</div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span> </div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span><span class="comment"></span> </div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span><span class="comment">   * Value for the length field in payload 1 that means &quot;not a length; indicating this is a ping message.&quot;</span></div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span><span class="comment">   * The other special values is 0 which indicates graceful close.  Also #S_MAX_META_BLOB_LENGTH must be adjusted</span></div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="comment">   * accordingly; S_META_BLOB_LENGTH_PING_SENTINEL being 0xFF....</span></div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment">   */</span></div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ad5e487595e2a58f7ff25b4f4c91fe4bc">  697</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a881c376f1ee37f9b1a20f770824f55d9">low_lvl_payload_blob_length_t</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ad5e487595e2a58f7ff25b4f4c91fe4bc">S_META_BLOB_LENGTH_PING_SENTINEL</a>;</div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span> </div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span>  <span class="comment">// Constructors.</span></div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment"></span> </div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span><span class="comment">   * Helper delegated-to ctor that sets up everything except #m_peer_socket (left null) and</span></div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment">   * #m_ev_wait_hndl_peer_socket (left holding no native handle); and sets NULL #m_state;</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span><span class="comment">   * the real ctor shall set both of them to their real initial values.</span></div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span><span class="comment">   *</span></div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span><span class="comment">   *        See other ctors.</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span><span class="comment">   * @param nickname_str</span></div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span><span class="comment">   *        See other ctors.</span></div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span><span class="comment">   * @param tag</span></div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span><span class="comment">   *        Ctor-selecting tag.</span></div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span><span class="comment">   */</span></div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span>  <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae9194e2eefe81185d1bf067b1f934657">Impl</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> nickname_str, std::nullptr_t tag);</div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span> </div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span> </div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span>  <span class="comment">// Connect-ops.</span></div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span><span class="comment"></span> </div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span><span class="comment">   * It is `start_ops&lt;Op::S_CONN&gt;()`.  See &quot;Connect-ops impl design&quot; in class doc header.  This guy could</span></div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span><span class="comment">   * someday become public if and only if async_connect() became public.</span></div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span><span class="comment">   *</span></div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span><span class="comment">   *        Usual `sync_io`-pattern meaning.</span></div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span><span class="comment">   * @return What start_ops() returns.</span></div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span><span class="comment">   */</span></div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c6214376ab8bc59823635d405f9704a">start_connect_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span><span class="comment"></span> </div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span><span class="comment">   * The core of sync_connect(), written in the `sync_io`-pattern style.  See &quot;Connect-ops impl design&quot; in class doc</span></div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span><span class="comment">   * header.  This guy (in slightly modified form, likely returning `bool` for example) could someday become public,</span></div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span><span class="comment">   * if we extend `*this` in some form to networked socket streams.  Until then: this must be called</span></div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span><span class="comment">   * in NULL state; otherwise behavior undefined (assertion may trip).</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="comment">   *</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   * As of this writing -- until it is networked -- this will always complete in a non-blocking amount of time,</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span><span class="comment">   * even if the call yields would-block (error::Code::S_SYNC_IO_WOULD_BLOCK).  So in the latter case it is still</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span><span class="comment">   * guaranteed that the internally-triggered async-wait via start_connect_ops() machinery shall be satisfied</span></div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span><span class="comment">   * immediately.  (See inside the code for OS-dependent subtleties, but the bottom line is as written.)</span></div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span><span class="comment">   *</span></div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span><span class="comment">   * @param absolute_name</span></div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span><span class="comment">   *        See sync_connect().</span></div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span><span class="comment">   *        Must not be null (assertion may trip otherwise; but if this becomes public null would be allowed).</span></div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span><span class="comment">   *        That aside: Usual `sync_io`-pattern meaning: If connect succeded or failed synchronously,</span></div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span><span class="comment">   *        this is set to the result (falsy indicating reaching PEER state); otherwise set to the usual</span></div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span><span class="comment">   *        would-block value.  In the latter case, per `sync_io`-pattern the `start_connect_ops()`-passed</span></div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span><span class="comment">   *        async-wait function shall be invoked to await a native-handle event condition; and once</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span><span class="comment">   *        the async op does complete, `on_done_func(E)` is invoked, where `E` is the async equivalent of</span></div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span><span class="comment">   *        `*sync_err_code`.</span></div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span><span class="comment">   *        See `sync_err_code`.</span></div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span><span class="comment">   */</span></div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ad6443fb49be059dbe76c75d86a18197e">async_connect</a>(<span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; absolute_name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code,</div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span>                     flow::async::Task_asio_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span><span class="comment"></span> </div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span><span class="comment">   * Handler for the async-wait in case async_connect() cannot synchronously complete the #m_peer_socket</span></div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span><span class="comment">   * connect (boost.asio yields would-block).  Post-condition: `on_done_func()` has finished.</span></div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span><span class="comment">   * Note that this situation is unlikely, this being a Unix domain socket (details commented inside async_connect()).</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span><span class="comment">   * (That comment says that in Linux as of this writing it is impossible.)  Moreover if we did get here,</span></div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span><span class="comment">   * then we have to assume it&#39;s writable -- connected -- and can&#39;t (or at least don&#39;t) try to see if</span></div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span><span class="comment">   * the connect really failed.  That said, trying to use it will expose any error shortly (in PEER state).</span></div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="comment">   *</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span><span class="comment">   *        See async_connect().</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span><span class="comment">   */</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aaf965dc1eea3bee807c2fb6c4a937bb5">conn_on_ev_peer_socket_writable</a>(flow::async::Task_asio_err&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span> </div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span>  <span class="comment">// Send-ops.</span></div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span><span class="comment"></span> </div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span><span class="comment">   * `*end_sending()` body.</span></div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span><span class="comment">   *</span></div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span><span class="comment">   * @param sync_err_code_ptr_or_null</span></div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span><span class="comment">   *        See async_end_sending().  Null if and only if invoked from the no-arg end_sending().</span></div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span><span class="comment">   *        Note well: even if `async_end_sending(sync_err_code = nullptr)` was used, this must not be null.</span></div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span><span class="comment">   * @param on_done_func_or_empty</span></div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span><span class="comment">   *        See async_end_sending().  `.empty() == true` if and only if invoked from the no-arg end_sending().</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span><span class="comment">   * @return See async_end_sending() and end_sending().</span></div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span><span class="comment">   */</span></div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6337b0d5d703f124def66853e36b62e5">async_end_sending_impl</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code_ptr_or_null,</div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span>                              flow::async::Task_asio_err&amp;&amp; on_done_func_or_empty);</div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span><span class="comment"></span> </div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment">   * Handler for the async-wait, via util::sync_io::Timer_event_emitter, of the auto-ping timer firing;</span></div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span><span class="comment">   * if all is cool, sends auto-ping and schedules the next such async-wait.  That wait itself can be rescheduled</span></div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span><span class="comment">   * when non-idleness (other send attempts) occurs.  If all is not cool -- sends finished via `*end_sending()`,</span></div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span><span class="comment">   * out-pipe hosed -- then neither sends auto-ping nor schedules another.</span></div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span><span class="comment">   */</span></div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4b31da3a7ff63f307bd08e288c391556">snd_on_ev_auto_ping_now_timer_fired</a>();</div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span><span class="comment"></span> </div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno">  792</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span><span class="comment">   * Either synchronously sends `hndl_or_null` handle (if any) and `orig_blob` low-level blob over #m_peer_socket,</span></div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span><span class="comment">   * or if an async-send is in progress queues both to be sent later; in the former case any unsent trailing portion</span></div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno">  795</span><span class="comment">   * of the payload is queued and async-sent via snd_async_write_q_head_payload(), with dropping-sans-queuing</span></div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span><span class="comment">   * allowed under certain circumstances in `avoid_qing` mode.  For details on the latter see below.</span></div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span><span class="comment">   *</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno">  798</span><span class="comment">   * #m_snd_pending_err_code, which as a pre-condition must be falsy, is set to truthy if and only if an</span></div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span><span class="comment">   * outgoing-pipe-hosing condition is synchronously encountered.  In particular, if it remains falsy upon return,</span></div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span><span class="comment">   * you may call this again to send the next low-level payload.  Otherwise #m_peer_socket cannot be subsequently used</span></div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span><span class="comment">   * in either direction (connection is hosed).</span></div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span><span class="comment">   *</span></div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span><span class="comment">   * ### `avoid_qing` mode for auto-ping ###</span></div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span><span class="comment">   * Setting this arg to `true` slightly modifies the above behavior as follows.  Suppose `orig_blob` encodes an</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span><span class="comment">   * auto-ping message (see auto_ping()).  (So `handle_or_null` must be `.null()`.)  Its purpose is to inform the</span></div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span><span class="comment">   * opposing side that we are alive/not idle.  So suppose this method is unable to send *any* of `orig_blob`,</span></div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span><span class="comment">   * either because there are already-queued bytes waiting to be sent pending writability (due to earlier would-block),</span></div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span><span class="comment">   * or because the kernel out-buffer has already-queued bytes waiting to be popped by receiver, and there is no</span></div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span><span class="comment">   * space there to enqueue any of `orig_blob`.  Then the receiver must not be keeping up with us, and the next</span></div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno">  810</span><span class="comment">   * pop of the kernel buffer will get *some* message, even if it&#39;s not the auto-ping we wanted to send;</span></div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span><span class="comment">   * hence they&#39;ll know we are not-idle without the auto-ping.  So in that case this method shall:</span></div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span><span class="comment">   *   - disregard `orig_blob` (do not queue it -- drop it, as it would be redundant anyway);</span></div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno">  813</span><span class="comment">   *   - return `true` if and only if the size of the out-queue is 0 (though as of this writing the caller should</span></div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span><span class="comment">   *     not care: auto-ping is a fire-and-forget operation, as long as it does not detect a pipe-hosing error).</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span><span class="comment">   *</span></div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span><span class="comment">   * @param hndl_or_null</span></div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span><span class="comment">   *        Similar to send_native_handle().  However it must be `.null()` if `avoid_qing == true`.</span></div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno">  818</span><span class="comment">   * @param orig_blob</span></div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno">  819</span><span class="comment">   *        Blob to send, with `hndl_or_null` associated with byte 1 of this.  It must have size 1 or greater,</span></div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span><span class="comment">   *        or behavior is undefined.</span></div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span><span class="comment">   * @param avoid_qing</span></div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span><span class="comment">   *        See above.  `true` &lt;=&gt; will return success (act as-if all of `orig_blob` was sent)</span></div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span><span class="comment">   *        if no bytes of `orig_blob` could be immediately sent.</span></div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span><span class="comment">   * @return `false` if outgoing-direction pipe still has queued stuff in it that must be sent once transport</span></div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span><span class="comment">   *         becomes writable; `true` otherwise.  If `true` is returned, but `avoid_qing == true`, then</span></div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span><span class="comment">   *         possibly `orig_blob` was not sent (at all); was dropped.</span></div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span><span class="comment">   */</span></div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1c949f345f0ceef5eeca3c2edec291">snd_sync_write_or_q_payload</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> hndl_or_null,</div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span>                                   <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; orig_blob, <span class="keywordtype">bool</span> avoid_qing);</div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span><span class="comment"></span> </div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span><span class="comment">   * Initiates async-write over #m_peer_socket of the low-level payload at the head of out-queue</span></div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span><span class="comment">   * #m_snd_pending_payloads_q, with completion handler snd_on_ev_peer_socket_writable_or_error().</span></div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span><span class="comment">   * The first step of this is an async-wait via `sync_io` pattern.</span></div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span><span class="comment">   *</span></div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span><span class="comment">   * Behavior w/r/t #m_snd_pending_err_code is the same semantics as described for snd_sync_write_or_q_payload()</span></div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span><span class="comment">   * (must be falsy as pre-condition, is set to truthy &lt;=&gt; outgoing-pipe-hosing condition is encountered).</span></div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno">  838</span><span class="comment">   */</span></div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5e9ed53ef25f4413c8da315f8dbcff2c">snd_async_write_q_head_payload</a>();</div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span><span class="comment"></span> </div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span><span class="comment">   * Completion handler, from outside event loop via `sync_io` pattern, for the async-wait initiated by</span></div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno">  843</span><span class="comment">   * snd_async_write_q_head_payload().  Continues the async-send chain by trying to</span></div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span><span class="comment">   * snd_nb_write_low_lvl_payload() as much of #m_snd_pending_payloads_q as it can synchronously;</span></div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span><span class="comment">   * invokes snd_async_write_q_head_payload() again if not all could be so sent.  Lastly, if indeed it sends-out</span></div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span><span class="comment">   * everything, or encounters out-pipe being hosed, and async_end_sending() completion handler is pending</span></div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span><span class="comment">   * to be called -- it ensures that occurs (synchronously inside).</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno">  848</span><span class="comment">   */</span></div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a2c2b11477fb5089af7608c45dec939c0">snd_on_ev_peer_socket_writable_or_error</a>();</div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno">  850</span><span class="comment"></span> </div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span><span class="comment">   * Utility that sends non-empty `blob`, and (unless null) `hndl_or_null` associated with its 1st byte,</span></div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno">  853</span><span class="comment">   * synchronously to the maximum extent possible without blocking, over #m_peer_socket.</span></div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span><span class="comment">   * This is used for all sync-writes in this class.  Note the result semantics are slightly different from</span></div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span><span class="comment">   * boost.asio and its extensions, so watch out about would-block and such:</span></div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span><span class="comment">   *</span></div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno">  857</span><span class="comment">   * `*err_code` shall be set to success unless #m_peer_socket connection is found to be hosed at any point throughout</span></div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span><span class="comment">   * the operation.  In particular neither would-block nor would-block after non-zero amount of data had been sent</span></div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span><span class="comment">   * are considered errors; 0 or a value `&lt; blob.size()` are returned in those situations respectively.</span></div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno">  860</span><span class="comment">   * If `*err_code` is made truthy, #m_peer_socket shall not be used (in either direction) subsequently.</span></div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span><span class="comment">   *</span></div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span><span class="comment">   * @param hndl_or_null</span></div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span><span class="comment">   *        Same as snd_sync_write_or_q_payload().</span></div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span><span class="comment">   * @param blob</span></div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span><span class="comment">   *        Same as snd_sync_write_or_q_payload().</span></div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span><span class="comment">   *        Same as snd_sync_write_or_q_payload() is w/r/t #m_snd_pending_err_code, essentially, with the small</span></div>
<div class="line"><a id="l00868" name="l00868"></a><span class="lineno">  868</span><span class="comment">   *        difference that it does not require `*err_code` to be falsy as pre-condition, and will make it truthy</span></div>
<div class="line"><a id="l00869" name="l00869"></a><span class="lineno">  869</span><span class="comment">   *        or falsy depending on success or failure.  (Minor possible to-do: just have it act on</span></div>
<div class="line"><a id="l00870" name="l00870"></a><span class="lineno">  870</span><span class="comment">   *        `m_snd_pending_err_code` like snd_sync_write_or_q_payload() et al?  It is the way it is now arguably for</span></div>
<div class="line"><a id="l00871" name="l00871"></a><span class="lineno">  871</span><span class="comment">   *        maintenability/reusability, and/or for minor historical reasons.)  Also see above: would-block is</span></div>
<div class="line"><a id="l00872" name="l00872"></a><span class="lineno">  872</span><span class="comment">   *        not an error.</span></div>
<div class="line"><a id="l00873" name="l00873"></a><span class="lineno">  873</span><span class="comment">   * @return 0 meaning neither `hndl_or_null` (if any) nor any `blob` bytes were sent;</span></div>
<div class="line"><a id="l00874" name="l00874"></a><span class="lineno">  874</span><span class="comment">   *         [1, `blob.size()`] if `hndl_or_null` (if any) and that number of `blob` bytes were sent.</span></div>
<div class="line"><a id="l00875" name="l00875"></a><span class="lineno">  875</span><span class="comment">   *         `*err_code` shall be truthy only if (but not necessarily if) `&lt; blob.size()` is returned.</span></div>
<div class="line"><a id="l00876" name="l00876"></a><span class="lineno">  876</span><span class="comment">   */</span></div>
<div class="line"><a id="l00877" name="l00877"></a><span class="lineno">  877</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#af321a9b3ed8dc21f23988bf79c7c33f0">snd_nb_write_low_lvl_payload</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> hndl_or_null, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>&amp; blob, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l00878" name="l00878"></a><span class="lineno">  878</span> </div>
<div class="line"><a id="l00879" name="l00879"></a><span class="lineno">  879</span>  <span class="comment">// Receive-ops.</span></div>
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno">  880</span><span class="comment"></span> </div>
<div class="line"><a id="l00881" name="l00881"></a><span class="lineno">  881</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno">  882</span><span class="comment">   * Handler for the async-wait, via util::sync_io::Timer_event_emitter, of the idle timer firing;</span></div>
<div class="line"><a id="l00883" name="l00883"></a><span class="lineno">  883</span><span class="comment">   * if still relevant it records the idle-timeout error in #m_rcv_pending_err_code; and if</span></div>
<div class="line"><a id="l00884" name="l00884"></a><span class="lineno">  884</span><span class="comment">   * an async_receive_native_handle_impl() is in progress (awaiting data via async-wait), it completes</span></div>
<div class="line"><a id="l00885" name="l00885"></a><span class="lineno">  885</span><span class="comment">   * that operation with the appropriate idle-timeout error (completion handler in #m_rcv_user_request runs</span></div>
<div class="line"><a id="l00886" name="l00886"></a><span class="lineno">  886</span><span class="comment">   * synchronously).  If not still relevant -- #m_rcv_pending_err_code already is truthy -- then no-ops.</span></div>
<div class="line"><a id="l00887" name="l00887"></a><span class="lineno">  887</span><span class="comment">   */</span></div>
<div class="line"><a id="l00888" name="l00888"></a><span class="lineno">  888</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a53b356e756923271fbb9b7a7beb8f54a">rcv_on_ev_idle_timer_fired</a>();</div>
<div class="line"><a id="l00889" name="l00889"></a><span class="lineno">  889</span><span class="comment"></span> </div>
<div class="line"><a id="l00890" name="l00890"></a><span class="lineno">  890</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00891" name="l00891"></a><span class="lineno">  891</span><span class="comment">   * No-ops if idle_timer_run() is not engaged; otherwise reacts to non-idleness of the in-pipe by</span></div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno">  892</span><span class="comment">   * rescheduling idle timer to occur in #m_rcv_idle_timeout again.</span></div>
<div class="line"><a id="l00893" name="l00893"></a><span class="lineno">  893</span><span class="comment">   * (Other code calls this, as of this writing, on receipt of a complete message.)</span></div>
<div class="line"><a id="l00894" name="l00894"></a><span class="lineno">  894</span><span class="comment">   *</span></div>
<div class="line"><a id="l00895" name="l00895"></a><span class="lineno">  895</span><span class="comment">   * Note that this can only occur while an async_receive_native_handle_impl() is in progress; as otherwise</span></div>
<div class="line"><a id="l00896" name="l00896"></a><span class="lineno">  896</span><span class="comment">   * we will not be reading the low-level in-pipe at all.  This is a requirement for using</span></div>
<div class="line"><a id="l00897" name="l00897"></a><span class="lineno">  897</span><span class="comment">   * idle_timer_run(), so it&#39;s not our fault, if they don&#39;t do it and get timed-out.</span></div>
<div class="line"><a id="l00898" name="l00898"></a><span class="lineno">  898</span><span class="comment">   */</span></div>
<div class="line"><a id="l00899" name="l00899"></a><span class="lineno">  899</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#adff873e21beee6c31a552293d8b0004c">rcv_not_idle</a>();</div>
<div class="line"><a id="l00900" name="l00900"></a><span class="lineno">  900</span><span class="comment"></span> </div>
<div class="line"><a id="l00901" name="l00901"></a><span class="lineno">  901</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00902" name="l00902"></a><span class="lineno">  902</span><span class="comment">   * Body of both async_receive_native_handle() and async_receive_blob().  In the latter case</span></div>
<div class="line"><a id="l00903" name="l00903"></a><span class="lineno">  903</span><span class="comment">   * `target_hndl_or_null` shall be null (otherwise it shall not).</span></div>
<div class="line"><a id="l00904" name="l00904"></a><span class="lineno">  904</span><span class="comment">   *</span></div>
<div class="line"><a id="l00905" name="l00905"></a><span class="lineno">  905</span><span class="comment">   * @param target_hndl_or_null</span></div>
<div class="line"><a id="l00906" name="l00906"></a><span class="lineno">  906</span><span class="comment">   *        See async_receive_native_handle(); or null if async_receive_blob().</span></div>
<div class="line"><a id="l00907" name="l00907"></a><span class="lineno">  907</span><span class="comment">   * @param target_meta_blob</span></div>
<div class="line"><a id="l00908" name="l00908"></a><span class="lineno">  908</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00909" name="l00909"></a><span class="lineno">  909</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00910" name="l00910"></a><span class="lineno">  910</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00911" name="l00911"></a><span class="lineno">  911</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00912" name="l00912"></a><span class="lineno">  912</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00913" name="l00913"></a><span class="lineno">  913</span><span class="comment">   * @param on_done_func</span></div>
<div class="line"><a id="l00914" name="l00914"></a><span class="lineno">  914</span><span class="comment">   *        See async_receive_native_handle().</span></div>
<div class="line"><a id="l00915" name="l00915"></a><span class="lineno">  915</span><span class="comment">   * @return See async_receive_native_handle().</span></div>
<div class="line"><a id="l00916" name="l00916"></a><span class="lineno">  916</span><span class="comment">   */</span></div>
<div class="line"><a id="l00917" name="l00917"></a><span class="lineno">  917</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae16d560bf3c4eccfa975d47af71cb145">async_receive_native_handle_impl</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_hndl_or_null, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_meta_blob,</div>
<div class="line"><a id="l00918" name="l00918"></a><span class="lineno">  918</span>                                        <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz,</div>
<div class="line"><a id="l00919" name="l00919"></a><span class="lineno">  919</span>                                        flow::async::Task_asio_err_sz&amp;&amp; on_done_func);</div>
<div class="line"><a id="l00920" name="l00920"></a><span class="lineno">  920</span><span class="comment"></span> </div>
<div class="line"><a id="l00921" name="l00921"></a><span class="lineno">  921</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00922" name="l00922"></a><span class="lineno">  922</span><span class="comment">   * Begins read chain (completing it as synchronously as possible, async-completing the rest) for the next</span></div>
<div class="line"><a id="l00923" name="l00923"></a><span class="lineno">  923</span><span class="comment">   * in-message.</span></div>
<div class="line"><a id="l00924" name="l00924"></a><span class="lineno">  924</span><span class="comment">   *</span></div>
<div class="line"><a id="l00925" name="l00925"></a><span class="lineno">  925</span><span class="comment">   * Given the pre-condition that (1) async_receive_native_handle_impl() is oustanding (#m_rcv_user_request not null),</span></div>
<div class="line"><a id="l00926" name="l00926"></a><span class="lineno">  926</span><span class="comment">   * (2) in the in-pipe we expect byte 1 of the next in-message next, (3) there is no known in-pipe error</span></div>
<div class="line"><a id="l00927" name="l00927"></a><span class="lineno">  927</span><span class="comment">   * already detected, and (4) there is no known would-block condition on the in-pipe: this reads (asynchronously</span></div>
<div class="line"><a id="l00928" name="l00928"></a><span class="lineno">  928</span><span class="comment">   * if would-block is encountered at some point in there) the next message.</span></div>
<div class="line"><a id="l00929" name="l00929"></a><span class="lineno">  929</span><span class="comment">   *</span></div>
<div class="line"><a id="l00930" name="l00930"></a><span class="lineno">  930</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00931" name="l00931"></a><span class="lineno">  931</span><span class="comment">   *        Outcome out-arg: error::Code::S_SYNC_IO_WOULD_BLOCK if async-wait triggered, as message could not be</span></div>
<div class="line"><a id="l00932" name="l00932"></a><span class="lineno">  932</span><span class="comment">   *        fully read synchronously; falsy if message fully read synchronously; non-would-block truthy value,</span></div>
<div class="line"><a id="l00933" name="l00933"></a><span class="lineno">  933</span><span class="comment">   *        if pipe-hosing condition encountered.</span></div>
<div class="line"><a id="l00934" name="l00934"></a><span class="lineno">  934</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00935" name="l00935"></a><span class="lineno">  935</span><span class="comment">   *        Outcome out-arg: If `*sync_err_code` truthy then zero; else size of completed in-message.</span></div>
<div class="line"><a id="l00936" name="l00936"></a><span class="lineno">  936</span><span class="comment">   */</span></div>
<div class="line"><a id="l00937" name="l00937"></a><span class="lineno">  937</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa8c4ec6715dc5c437ed285cfea600b46">rcv_read_msg</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz);</div>
<div class="line"><a id="l00938" name="l00938"></a><span class="lineno">  938</span><span class="comment"></span> </div>
<div class="line"><a id="l00939" name="l00939"></a><span class="lineno">  939</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00940" name="l00940"></a><span class="lineno">  940</span><span class="comment">   * A somewhat-general utility that continues read chain with the aim to complete the present in-message,</span></div>
<div class="line"><a id="l00941" name="l00941"></a><span class="lineno">  941</span><span class="comment">   * with the pre-condition (among others) that (1) there is no known would-block condition on the in-pipe, and</span></div>
<div class="line"><a id="l00942" name="l00942"></a><span class="lineno">  942</span><span class="comment">   * (2) at least byte 1 + the handle-or-not within payload 1 have already been acquired.</span></div>
<div class="line"><a id="l00943" name="l00943"></a><span class="lineno">  943</span><span class="comment">   *</span></div>
<div class="line"><a id="l00944" name="l00944"></a><span class="lineno">  944</span><span class="comment">   * @param msg_state</span></div>
<div class="line"><a id="l00945" name="l00945"></a><span class="lineno">  945</span><span class="comment">   *        Rcv_msg_state::S_HEAD_PAYLOAD or Rcv_msg_state::S_META_BLOB_PAYLOAD, indicating which</span></div>
<div class="line"><a id="l00946" name="l00946"></a><span class="lineno">  946</span><span class="comment">   *        thing is being read: trailing bytes (not including byte 1) of payload 1; or</span></div>
<div class="line"><a id="l00947" name="l00947"></a><span class="lineno">  947</span><span class="comment">   *        all or trailing bytes of payload 2 (the meta-blob).</span></div>
<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span><span class="comment">   * @param target_blob</span></div>
<div class="line"><a id="l00949" name="l00949"></a><span class="lineno">  949</span><span class="comment">   *        The target buffer: its size indicates the bytes necessary to complete the payload `msg_state`.</span></div>
<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span><span class="comment">   *        E.g., if META_BLOB_PAYLOAD and 3 of (whatever m_rcv_target_meta_length indicates, from payload 1)</span></div>
<div class="line"><a id="l00951" name="l00951"></a><span class="lineno">  951</span><span class="comment">   *        bytes are still needed, then `target_blob.size() == 3`, and `target_blob.data()` points to</span></div>
<div class="line"><a id="l00952" name="l00952"></a><span class="lineno">  952</span><span class="comment">   *        the end of the meta-blob (in #m_rcv_user_request) minus 3.</span></div>
<div class="line"><a id="l00953" name="l00953"></a><span class="lineno">  953</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00954" name="l00954"></a><span class="lineno">  954</span><span class="comment">   *        Outcome out-arg: error::Code::S_SYNC_IO_WOULD_BLOCK if async-wait triggered, as message could not be</span></div>
<div class="line"><a id="l00955" name="l00955"></a><span class="lineno">  955</span><span class="comment">   *        fully read synchronously; falsy if message fully read synchronously; non-would-block truthy value,</span></div>
<div class="line"><a id="l00956" name="l00956"></a><span class="lineno">  956</span><span class="comment">   *        if pipe-hosing condition encountered.</span></div>
<div class="line"><a id="l00957" name="l00957"></a><span class="lineno">  957</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00958" name="l00958"></a><span class="lineno">  958</span><span class="comment">   *        Outcome out-arg: If `*sync_err_code` truthy then zero; else size of completed in-message.</span></div>
<div class="line"><a id="l00959" name="l00959"></a><span class="lineno">  959</span><span class="comment">   */</span></div>
<div class="line"><a id="l00960" name="l00960"></a><span class="lineno">  960</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ba676425c97ae496255a155f41943f8">rcv_read_blob</a>(<a class="code hl_enumeration" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0e765fbfee2c76293b572b01c9be5680">Rcv_msg_state</a> msg_state, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_blob,</div>
<div class="line"><a id="l00961" name="l00961"></a><span class="lineno">  961</span>                     <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz);</div>
<div class="line"><a id="l00962" name="l00962"></a><span class="lineno">  962</span><span class="comment"></span> </div>
<div class="line"><a id="l00963" name="l00963"></a><span class="lineno">  963</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00964" name="l00964"></a><span class="lineno">  964</span><span class="comment">   * Helper of rcv_read_msg() -- it could have been inlined instead of a method but for readability concerns --</span></div>
<div class="line"><a id="l00965" name="l00965"></a><span class="lineno">  965</span><span class="comment">   * that reacts to that guy&#39;s initial nb-read (into `Native_handle` + leading bytes of payload 1 blob)</span></div>
<div class="line"><a id="l00966" name="l00966"></a><span class="lineno">  966</span><span class="comment">   * getting at least 1 byte (and therefore the `Native_handle` if any).  A number of things can happen</span></div>
<div class="line"><a id="l00967" name="l00967"></a><span class="lineno">  967</span><span class="comment">   * depending on `n_rcvd`; and if `n_rcvd` = all of payload 1, it&#39;s rcv_on_head_payload() time.</span></div>
<div class="line"><a id="l00968" name="l00968"></a><span class="lineno">  968</span><span class="comment">   *</span></div>
<div class="line"><a id="l00969" name="l00969"></a><span class="lineno">  969</span><span class="comment">   * @param hndl_or_null</span></div>
<div class="line"><a id="l00970" name="l00970"></a><span class="lineno">  970</span><span class="comment">   *        The handle, or none, received with byte 1 of payload 1.</span></div>
<div class="line"><a id="l00971" name="l00971"></a><span class="lineno">  971</span><span class="comment">   * @param n_rcvd</span></div>
<div class="line"><a id="l00972" name="l00972"></a><span class="lineno">  972</span><span class="comment">   *        How many bytes of payload 1 were received.  Must be at least 1, or behavior undefined (assertion may</span></div>
<div class="line"><a id="l00973" name="l00973"></a><span class="lineno">  973</span><span class="comment">   *        trip).</span></div>
<div class="line"><a id="l00974" name="l00974"></a><span class="lineno">  974</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00975" name="l00975"></a><span class="lineno">  975</span><span class="comment">   *        Outcome out-arg: error::Code::S_SYNC_IO_WOULD_BLOCK if async-wait triggered, as message could not be</span></div>
<div class="line"><a id="l00976" name="l00976"></a><span class="lineno">  976</span><span class="comment">   *        fully read synchronously; falsy if message fully read synchronously; non-would-block truthy value,</span></div>
<div class="line"><a id="l00977" name="l00977"></a><span class="lineno">  977</span><span class="comment">   *        if pipe-hosing condition encountered.</span></div>
<div class="line"><a id="l00978" name="l00978"></a><span class="lineno">  978</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l00979" name="l00979"></a><span class="lineno">  979</span><span class="comment">   *        Outcome out-arg: If `*sync_err_code` truthy then zero; else size of completed in-message.</span></div>
<div class="line"><a id="l00980" name="l00980"></a><span class="lineno">  980</span><span class="comment">   */</span></div>
<div class="line"><a id="l00981" name="l00981"></a><span class="lineno">  981</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa342b6f0c7e2015517a5c465e4963fc7">rcv_on_handle_finalized</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a> hndl_or_null, <span class="keywordtype">size_t</span> n_rcvd,</div>
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno">  982</span>                               <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz);</div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno">  983</span><span class="comment"></span> </div>
<div class="line"><a id="l00984" name="l00984"></a><span class="lineno">  984</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00985" name="l00985"></a><span class="lineno">  985</span><span class="comment">   * Reacts to payload 1 having been completely received.  At this point #m_rcv_target_meta_length is ready,</span></div>
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno">  986</span><span class="comment">   * and #m_peer_socket is not known to be in would-block state (which isn&#39;t to say it&#39;s *not* in would-block</span></div>
<div class="line"><a id="l00987" name="l00987"></a><span class="lineno">  987</span><span class="comment">   * state).</span></div>
<div class="line"><a id="l00988" name="l00988"></a><span class="lineno">  988</span><span class="comment">   *   - So if that value contains auto-ping marker, then it&#39;s rcv_read_msg() all over again.</span></div>
<div class="line"><a id="l00989" name="l00989"></a><span class="lineno">  989</span><span class="comment">   *   - If it&#39;s the graceful-close marker, then the in-pipe (but not out-pipe necessarily) is hosed with</span></div>
<div class="line"><a id="l00990" name="l00990"></a><span class="lineno">  990</span><span class="comment">   *     graceful-close &quot;error&quot;; hence the completion handler in #m_rcv_user_request is readied for execution;</span></div>
<div class="line"><a id="l00991" name="l00991"></a><span class="lineno">  991</span><span class="comment">   *     the read-chain stops until the next async_receive_native_handle_impl().</span></div>
<div class="line"><a id="l00992" name="l00992"></a><span class="lineno">  992</span><span class="comment">   *   - Otherwise we need payload 2; rcv_read_blob() is initiated (with Rcv_msg_state::S_META_BLOB_PAYLOAD)</span></div>
<div class="line"><a id="l00993" name="l00993"></a><span class="lineno">  993</span><span class="comment">   *     to read all of it.</span></div>
<div class="line"><a id="l00994" name="l00994"></a><span class="lineno">  994</span><span class="comment">   *</span></div>
<div class="line"><a id="l00995" name="l00995"></a><span class="lineno">  995</span><span class="comment">   * @param sync_err_code</span></div>
<div class="line"><a id="l00996" name="l00996"></a><span class="lineno">  996</span><span class="comment">   *        Outcome out-arg: error::Code::S_SYNC_IO_WOULD_BLOCK if async-wait triggered, as message could not be</span></div>
<div class="line"><a id="l00997" name="l00997"></a><span class="lineno">  997</span><span class="comment">   *        fully read synchronously; falsy if message fully read synchronously; non-would-block truthy value,</span></div>
<div class="line"><a id="l00998" name="l00998"></a><span class="lineno">  998</span><span class="comment">   *        if pipe-hosing condition encountered.</span></div>
<div class="line"><a id="l00999" name="l00999"></a><span class="lineno">  999</span><span class="comment">   * @param sync_sz</span></div>
<div class="line"><a id="l01000" name="l01000"></a><span class="lineno"> 1000</span><span class="comment">   *        Outcome out-arg: If `*sync_err_code` truthy then zero; else size of completed in-message.</span></div>
<div class="line"><a id="l01001" name="l01001"></a><span class="lineno"> 1001</span><span class="comment">   */</span></div>
<div class="line"><a id="l01002" name="l01002"></a><span class="lineno"> 1002</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3b6b76dfbddc562ece4f64742ff6d2c7">rcv_on_head_payload</a>(<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* sync_err_code, <span class="keywordtype">size_t</span>* sync_sz);</div>
<div class="line"><a id="l01003" name="l01003"></a><span class="lineno"> 1003</span><span class="comment"></span> </div>
<div class="line"><a id="l01004" name="l01004"></a><span class="lineno"> 1004</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01005" name="l01005"></a><span class="lineno"> 1005</span><span class="comment">   * Completion handler, from outside event loop via `sync_io` pattern, for the async-wait initiated by</span></div>
<div class="line"><a id="l01006" name="l01006"></a><span class="lineno"> 1006</span><span class="comment">   * various `rcv_*()` methods trying to get to the goal of obtaining a complete in-message.</span></div>
<div class="line"><a id="l01007" name="l01007"></a><span class="lineno"> 1007</span><span class="comment">   * It tries to resume from whatever point in that algorithm we were at, when an rcv_nb_read_low_lvl_payload()</span></div>
<div class="line"><a id="l01008" name="l01008"></a><span class="lineno"> 1008</span><span class="comment">   * indicated would-block, precipitating the async-wait that has now completed.</span></div>
<div class="line"><a id="l01009" name="l01009"></a><span class="lineno"> 1009</span><span class="comment">   * That point is indicated by the args, which were memorized (captured) at the time the async-wait was</span></div>
<div class="line"><a id="l01010" name="l01010"></a><span class="lineno"> 1010</span><span class="comment">   * started.</span></div>
<div class="line"><a id="l01011" name="l01011"></a><span class="lineno"> 1011</span><span class="comment">   *</span></div>
<div class="line"><a id="l01012" name="l01012"></a><span class="lineno"> 1012</span><span class="comment">   * @param msg_state</span></div>
<div class="line"><a id="l01013" name="l01013"></a><span class="lineno"> 1013</span><span class="comment">   *        Communicates where we&#39;re at in the in-message: the very start; or at byte 2+ of payload 1;</span></div>
<div class="line"><a id="l01014" name="l01014"></a><span class="lineno"> 1014</span><span class="comment">   *        or in payload 2.</span></div>
<div class="line"><a id="l01015" name="l01015"></a><span class="lineno"> 1015</span><span class="comment">   * @param n_left</span></div>
<div class="line"><a id="l01016" name="l01016"></a><span class="lineno"> 1016</span><span class="comment">   *        How many bytes are left to read within payload 1 or payload 2 (depending on `msg_state`).</span></div>
<div class="line"><a id="l01017" name="l01017"></a><span class="lineno"> 1017</span><span class="comment">   *        Ignored for Rcv_msg_state::S_MSG_START (by definition all of payload 1 remains then).</span></div>
<div class="line"><a id="l01018" name="l01018"></a><span class="lineno"> 1018</span><span class="comment">   */</span></div>
<div class="line"><a id="l01019" name="l01019"></a><span class="lineno"> 1019</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#af324ad8945ab79d74e937e9c38c2fbb5">rcv_on_ev_peer_socket_readable_or_error</a>(<a class="code hl_enumeration" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0e765fbfee2c76293b572b01c9be5680">Rcv_msg_state</a> msg_state, <span class="keywordtype">size_t</span> n_left);</div>
<div class="line"><a id="l01020" name="l01020"></a><span class="lineno"> 1020</span><span class="comment"></span> </div>
<div class="line"><a id="l01021" name="l01021"></a><span class="lineno"> 1021</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01022" name="l01022"></a><span class="lineno"> 1022</span><span class="comment">   * Utility that synchronously, non-blockingly attempts to read over #m_peer_socket into the target blob and</span></div>
<div class="line"><a id="l01023" name="l01023"></a><span class="lineno"> 1023</span><span class="comment">   * (optionally) `Native_handle` (nullifying it if not present), reporting error or would-block if encountered.</span></div>
<div class="line"><a id="l01024" name="l01024"></a><span class="lineno"> 1024</span><span class="comment">   * This is used for all sync-reads in this class.  Note the result semantics are slightly different from</span></div>
<div class="line"><a id="l01025" name="l01025"></a><span class="lineno"> 1025</span><span class="comment">   * boost.asio and its extensions, so watch out about would-block and such:</span></div>
<div class="line"><a id="l01026" name="l01026"></a><span class="lineno"> 1026</span><span class="comment">   *</span></div>
<div class="line"><a id="l01027" name="l01027"></a><span class="lineno"> 1027</span><span class="comment">   * `*err_code` shall be set to success unless #m_peer_socket connection is found to be hosed at any point throughout</span></div>
<div class="line"><a id="l01028" name="l01028"></a><span class="lineno"> 1028</span><span class="comment">   * the operation.  In particular neither would-block nor would-block after non-zero amount of data had been read</span></div>
<div class="line"><a id="l01029" name="l01029"></a><span class="lineno"> 1029</span><span class="comment">   * are considered errors; 0 or a value `&lt; target_payload_blob.size()` are returned in those situations respectively.</span></div>
<div class="line"><a id="l01030" name="l01030"></a><span class="lineno"> 1030</span><span class="comment">   * If `*err_code` is made truthy, #m_peer_socket shall not be used (in either direction) subsequently.</span></div>
<div class="line"><a id="l01031" name="l01031"></a><span class="lineno"> 1031</span><span class="comment">   *</span></div>
<div class="line"><a id="l01032" name="l01032"></a><span class="lineno"> 1032</span><span class="comment">   * @param target_payload_hndl_or_null</span></div>
<div class="line"><a id="l01033" name="l01033"></a><span class="lineno"> 1033</span><span class="comment">   *        If null, we will use a plain-read (even if there is a `Native_handle`, we will be none-the-wiser --</span></div>
<div class="line"><a id="l01034" name="l01034"></a><span class="lineno"> 1034</span><span class="comment">   *        we are not expecting it, so only pass null at the proper points in the protocol stream).</span></div>
<div class="line"><a id="l01035" name="l01035"></a><span class="lineno"> 1035</span><span class="comment">   *        Otherwise, if and only if 1+ bytes are read OK, then the pointee is set to either null (byte 1 not</span></div>
<div class="line"><a id="l01036" name="l01036"></a><span class="lineno"> 1036</span><span class="comment">   *        accompanied by a handle) or non-null (it was-too accompanied by a handle).</span></div>
<div class="line"><a id="l01037" name="l01037"></a><span class="lineno"> 1037</span><span class="comment">   * @param target_payload_blob</span></div>
<div class="line"><a id="l01038" name="l01038"></a><span class="lineno"> 1038</span><span class="comment">   *        Target buffer (its size indicating how many bytes we want if possible).</span></div>
<div class="line"><a id="l01039" name="l01039"></a><span class="lineno"> 1039</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l01040" name="l01040"></a><span class="lineno"> 1040</span><span class="comment">   *        See above: would-block is not an error.  Return value should be ignored if `*err_code` has been made truthy.</span></div>
<div class="line"><a id="l01041" name="l01041"></a><span class="lineno"> 1041</span><span class="comment">   * @return If `*err_code` is falsy at return time:</span></div>
<div class="line"><a id="l01042" name="l01042"></a><span class="lineno"> 1042</span><span class="comment">   *         0 meaning`*target_payload_hndl_or_null` is indeterminate (if ptr was not null), and no bytes were</span></div>
<div class="line"><a id="l01043" name="l01043"></a><span class="lineno"> 1043</span><span class="comment">   *         received + would-block;</span></div>
<div class="line"><a id="l01044" name="l01044"></a><span class="lineno"> 1044</span><span class="comment">   *         [1, `blob.size()`] if `*target_payload_hndl_or_null` has been finalized (if ptr was not null),</span></div>
<div class="line"><a id="l01045" name="l01045"></a><span class="lineno"> 1045</span><span class="comment">   *         and that many bytes were indeed read into the start of `target_payload_blob`.</span></div>
<div class="line"><a id="l01046" name="l01046"></a><span class="lineno"> 1046</span><span class="comment">   *         `*err_code` shall be truthy only if (but not necessarily if) `&lt; blob.size()` is returned.</span></div>
<div class="line"><a id="l01047" name="l01047"></a><span class="lineno"> 1047</span><span class="comment">   */</span></div>
<div class="line"><a id="l01048" name="l01048"></a><span class="lineno"> 1048</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a25e051170a8eb568745f809bb186f980">rcv_nb_read_low_lvl_payload</a>(<a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">Native_handle</a>* target_payload_hndl_or_null,</div>
<div class="line"><a id="l01049" name="l01049"></a><span class="lineno"> 1049</span>                                     <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>&amp; target_payload_blob,</div>
<div class="line"><a id="l01050" name="l01050"></a><span class="lineno"> 1050</span>                                     <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code);</div>
<div class="line"><a id="l01051" name="l01051"></a><span class="lineno"> 1051</span> </div>
<div class="line"><a id="l01052" name="l01052"></a><span class="lineno"> 1052</span>  <span class="comment">// Utilities.</span></div>
<div class="line"><a id="l01053" name="l01053"></a><span class="lineno"> 1053</span><span class="comment"></span> </div>
<div class="line"><a id="l01054" name="l01054"></a><span class="lineno"> 1054</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01055" name="l01055"></a><span class="lineno"> 1055</span><span class="comment">   * Checks whether #m_state has reached State::S_PEER; if so returns `true`; if not logs WARNING and returns `false`.</span></div>
<div class="line"><a id="l01056" name="l01056"></a><span class="lineno"> 1056</span><span class="comment">   * In the latter case the caller should immediately return; in the former it should continue.</span></div>
<div class="line"><a id="l01057" name="l01057"></a><span class="lineno"> 1057</span><span class="comment">   *</span></div>
<div class="line"><a id="l01058" name="l01058"></a><span class="lineno"> 1058</span><span class="comment">   * Intended use: All public APIs that require PEER state shall do this ~first-thing.</span></div>
<div class="line"><a id="l01059" name="l01059"></a><span class="lineno"> 1059</span><span class="comment">   *</span></div>
<div class="line"><a id="l01060" name="l01060"></a><span class="lineno"> 1060</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l01061" name="l01061"></a><span class="lineno"> 1061</span><span class="comment">   * In the context of reaching PEER state, #m_state is essentially a barrier of sorts: PEER is the terminal state</span></div>
<div class="line"><a id="l01062" name="l01062"></a><span class="lineno"> 1062</span><span class="comment">   * (one cannot exit it until dtor), and connected-state operations all promise to immediately return `false`</span></div>
<div class="line"><a id="l01063" name="l01063"></a><span class="lineno"> 1063</span><span class="comment">   * (or equivalent) unless PEER has been reached.</span></div>
<div class="line"><a id="l01064" name="l01064"></a><span class="lineno"> 1064</span><span class="comment">   *</span></div>
<div class="line"><a id="l01065" name="l01065"></a><span class="lineno"> 1065</span><span class="comment">   * @param context</span></div>
<div class="line"><a id="l01066" name="l01066"></a><span class="lineno"> 1066</span><span class="comment">   *        Description of caller (probably `&quot;...func_name...(...more-info-maybe...)&quot;`) for logging.</span></div>
<div class="line"><a id="l01067" name="l01067"></a><span class="lineno"> 1067</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l01068" name="l01068"></a><span class="lineno"> 1068</span><span class="comment">   */</span></div>
<div class="line"><a id="l01069" name="l01069"></a><span class="lineno"> 1069</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a18de125ad318ba69cee7d8cb8204ad12">state_peer</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> context) <span class="keyword">const</span>;</div>
<div class="line"><a id="l01070" name="l01070"></a><span class="lineno"> 1070</span><span class="comment"></span> </div>
<div class="line"><a id="l01071" name="l01071"></a><span class="lineno"> 1071</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01072" name="l01072"></a><span class="lineno"> 1072</span><span class="comment">   * For boiler-plate-reducing generic code: Returns the `m_*_ev_wait_func` corresponding to the given Op.</span></div>
<div class="line"><a id="l01073" name="l01073"></a><span class="lineno"> 1073</span><span class="comment">   *</span></div>
<div class="line"><a id="l01074" name="l01074"></a><span class="lineno"> 1074</span><span class="comment">   * @tparam OP</span></div>
<div class="line"><a id="l01075" name="l01075"></a><span class="lineno"> 1075</span><span class="comment">   *         See Op.</span></div>
<div class="line"><a id="l01076" name="l01076"></a><span class="lineno"> 1076</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l01077" name="l01077"></a><span class="lineno"> 1077</span><span class="comment">   */</span></div>
<div class="line"><a id="l01078" name="l01078"></a><span class="lineno"> 1078</span>  <span class="keyword">template</span>&lt;Op OP&gt;</div>
<div class="line"><a id="l01079" name="l01079"></a><span class="lineno"> 1079</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>* <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1ea07348e9e1cd7ff6c8dbdca290d9">sync_io_ev_wait_func</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l01080" name="l01080"></a><span class="lineno"> 1080</span><span class="comment"></span> </div>
<div class="line"><a id="l01081" name="l01081"></a><span class="lineno"> 1081</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01082" name="l01082"></a><span class="lineno"> 1082</span><span class="comment">   * `const` version of the other overload.</span></div>
<div class="line"><a id="l01083" name="l01083"></a><span class="lineno"> 1083</span><span class="comment">   *</span></div>
<div class="line"><a id="l01084" name="l01084"></a><span class="lineno"> 1084</span><span class="comment">   * @tparam OP</span></div>
<div class="line"><a id="l01085" name="l01085"></a><span class="lineno"> 1085</span><span class="comment">   *         See above.</span></div>
<div class="line"><a id="l01086" name="l01086"></a><span class="lineno"> 1086</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l01087" name="l01087"></a><span class="lineno"> 1087</span><span class="comment">   */</span></div>
<div class="line"><a id="l01088" name="l01088"></a><span class="lineno"> 1088</span>  <span class="keyword">template</span>&lt;Op OP&gt;</div>
<div class="line"><a id="l01089" name="l01089"></a><span class="lineno"> 1089</span>  <a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>* <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1ea07348e9e1cd7ff6c8dbdca290d9">sync_io_ev_wait_func</a>();</div>
<div class="line"><a id="l01090" name="l01090"></a><span class="lineno"> 1090</span><span class="comment"></span> </div>
<div class="line"><a id="l01091" name="l01091"></a><span class="lineno"> 1091</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01092" name="l01092"></a><span class="lineno"> 1092</span><span class="comment">   * Helper that returns `true` silently if the given Op `start_*_ops()` has been called; else</span></div>
<div class="line"><a id="l01093" name="l01093"></a><span class="lineno"> 1093</span><span class="comment">   * logs WARNING and returns `false`.</span></div>
<div class="line"><a id="l01094" name="l01094"></a><span class="lineno"> 1094</span><span class="comment">   *</span></div>
<div class="line"><a id="l01095" name="l01095"></a><span class="lineno"> 1095</span><span class="comment">   * @param context</span></div>
<div class="line"><a id="l01096" name="l01096"></a><span class="lineno"> 1096</span><span class="comment">   *        For logging: the algorithmic context (function name or whatever).</span></div>
<div class="line"><a id="l01097" name="l01097"></a><span class="lineno"> 1097</span><span class="comment">   * @return See `start_*_ops()`.</span></div>
<div class="line"><a id="l01098" name="l01098"></a><span class="lineno"> 1098</span><span class="comment">   */</span></div>
<div class="line"><a id="l01099" name="l01099"></a><span class="lineno"> 1099</span>  <span class="keyword">template</span>&lt;Op OP&gt;</div>
<div class="line"><a id="l01100" name="l01100"></a><span class="lineno"> 1100</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7457705b8f6e8fc6c73dd758e593c7a9">op_started</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> context) <span class="keyword">const</span>;</div>
<div class="line"><a id="l01101" name="l01101"></a><span class="lineno"> 1101</span><span class="comment"></span> </div>
<div class="line"><a id="l01102" name="l01102"></a><span class="lineno"> 1102</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01103" name="l01103"></a><span class="lineno"> 1103</span><span class="comment">   * Boiler-plate-reducing body of `start_*_ops()` for the given Op.</span></div>
<div class="line"><a id="l01104" name="l01104"></a><span class="lineno"> 1104</span><span class="comment">   *</span></div>
<div class="line"><a id="l01105" name="l01105"></a><span class="lineno"> 1105</span><span class="comment">   * @tparam OP</span></div>
<div class="line"><a id="l01106" name="l01106"></a><span class="lineno"> 1106</span><span class="comment">   *         See Op.</span></div>
<div class="line"><a id="l01107" name="l01107"></a><span class="lineno"> 1107</span><span class="comment">   * @param ev_wait_func</span></div>
<div class="line"><a id="l01108" name="l01108"></a><span class="lineno"> 1108</span><span class="comment">   *        See `start_*_ops()`.</span></div>
<div class="line"><a id="l01109" name="l01109"></a><span class="lineno"> 1109</span><span class="comment">   * @return See `start_*_ops()`.  Note that start_connect_ops(), as a special case, no-ops and returns `false`</span></div>
<div class="line"><a id="l01110" name="l01110"></a><span class="lineno"> 1110</span><span class="comment">   *         if #m_state is not NULL.</span></div>
<div class="line"><a id="l01111" name="l01111"></a><span class="lineno"> 1111</span><span class="comment">   */</span></div>
<div class="line"><a id="l01112" name="l01112"></a><span class="lineno"> 1112</span>  <span class="keyword">template</span>&lt;Op OP&gt;</div>
<div class="line"><a id="l01113" name="l01113"></a><span class="lineno"> 1113</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7065a2f2c759cc9e66d46c613e628a96">start_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func);</div>
<div class="line"><a id="l01114" name="l01114"></a><span class="lineno"> 1114</span> </div>
<div class="line"><a id="l01115" name="l01115"></a><span class="lineno"> 1115</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l01116" name="l01116"></a><span class="lineno"> 1116</span> </div>
<div class="line"><a id="l01117" name="l01117"></a><span class="lineno"> 1117</span>  <span class="comment">// General data (both-direction pipes, connects, general).</span></div>
<div class="line"><a id="l01118" name="l01118"></a><span class="lineno"> 1118</span><span class="comment"></span> </div>
<div class="line"><a id="l01119" name="l01119"></a><span class="lineno"> 1119</span><span class="comment">  /// See nickname().</span></div>
<div class="line"><a id="l01120" name="l01120"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1374593e1cecd44ccb07d939f3673a35"> 1120</a></span><span class="comment"></span>  std::string <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1374593e1cecd44ccb07d939f3673a35">m_nickname</a>;</div>
<div class="line"><a id="l01121" name="l01121"></a><span class="lineno"> 1121</span><span class="comment"></span> </div>
<div class="line"><a id="l01122" name="l01122"></a><span class="lineno"> 1122</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01123" name="l01123"></a><span class="lineno"> 1123</span><span class="comment">   * The current state of `*this`.</span></div>
<div class="line"><a id="l01124" name="l01124"></a><span class="lineno"> 1124</span><span class="comment">   *</span></div>
<div class="line"><a id="l01125" name="l01125"></a><span class="lineno"> 1125</span><span class="comment">   * @see `State` doc header for details about transitions, initial and terminal states, etc.</span></div>
<div class="line"><a id="l01126" name="l01126"></a><span class="lineno"> 1126</span><span class="comment">   *</span></div>
<div class="line"><a id="l01127" name="l01127"></a><span class="lineno"> 1127</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l01128" name="l01128"></a><span class="lineno"> 1128</span><span class="comment">   * Long story short this exists purely to ensure (1) the user only attempts transmission-related public ops</span></div>
<div class="line"><a id="l01129" name="l01129"></a><span class="lineno"> 1129</span><span class="comment">   * once in the (terminal) PEER state; and (2) the user only attempts async_connect() while in the (initial)</span></div>
<div class="line"><a id="l01130" name="l01130"></a><span class="lineno"> 1130</span><span class="comment">   * NULL state (and not, say, while already CONNECTING; or already connected (PEER)).</span></div>
<div class="line"><a id="l01131" name="l01131"></a><span class="lineno"> 1131</span><span class="comment">   *</span></div>
<div class="line"><a id="l01132" name="l01132"></a><span class="lineno"> 1132</span><span class="comment">   * state_peer() handles the check for PEER.</span></div>
<div class="line"><a id="l01133" name="l01133"></a><span class="lineno"> 1133</span><span class="comment">   *</span></div>
<div class="line"><a id="l01134" name="l01134"></a><span class="lineno"> 1134</span><span class="comment">   * async_connect() and its completion handler conn_on_async_connect_or_error() handle all transitions</span></div>
<div class="line"><a id="l01135" name="l01135"></a><span class="lineno"> 1135</span><span class="comment">   * (NULL -&gt; CONNECTING, CONNECTING -&gt; NULL, CONNECTING -&gt; PEER).</span></div>
<div class="line"><a id="l01136" name="l01136"></a><span class="lineno"> 1136</span><span class="comment">   *</span></div>
<div class="line"><a id="l01137" name="l01137"></a><span class="lineno"> 1137</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01138" name="l01138"></a><span class="lineno"> 1138</span><span class="comment">   * First take a look at &quot;Thread safety&quot; in sync_io::Native_socket_stream class public doc header.</span></div>
<div class="line"><a id="l01139" name="l01139"></a><span class="lineno"> 1139</span><span class="comment">   * Long story short, it says that the only relevant concurrency we must allow is a receive-op being</span></div>
<div class="line"><a id="l01140" name="l01140"></a><span class="lineno"> 1140</span><span class="comment">   * invoked concurrently with a send-op while in PEER state.  And indeed most such methods do check</span></div>
<div class="line"><a id="l01141" name="l01141"></a><span class="lineno"> 1141</span><span class="comment">   * #m_state near the top.  However, by definition, in PEER state, #m_state is constant.  Therefore</span></div>
<div class="line"><a id="l01142" name="l01142"></a><span class="lineno"> 1142</span><span class="comment">   * no locking is needed.  (Contrast, potentially, with `m_*peer_socket` -- the only other mutable datum</span></div>
<div class="line"><a id="l01143" name="l01143"></a><span class="lineno"> 1143</span><span class="comment">   * accessed by both directions&#39; algorithms.)</span></div>
<div class="line"><a id="l01144" name="l01144"></a><span class="lineno"> 1144</span><span class="comment">   */</span></div>
<div class="line"><a id="l01145" name="l01145"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a64e47a38b3ed59e37295336114918142"> 1145</a></span>  <a class="code hl_enumeration" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9c9825f74472868eb1397c33edf78fb4">State</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a64e47a38b3ed59e37295336114918142">m_state</a>;</div>
<div class="line"><a id="l01146" name="l01146"></a><span class="lineno"> 1146</span><span class="comment"></span> </div>
<div class="line"><a id="l01147" name="l01147"></a><span class="lineno"> 1147</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01148" name="l01148"></a><span class="lineno"> 1148</span><span class="comment">   * Handles the protocol negotiation at the start of the pipe.</span></div>
<div class="line"><a id="l01149" name="l01149"></a><span class="lineno"> 1149</span><span class="comment">   *</span></div>
<div class="line"><a id="l01150" name="l01150"></a><span class="lineno"> 1150</span><span class="comment">   * @see Protocol_negotiator doc header for key background on the topic.  In particular check out the discussion</span></div>
<div class="line"><a id="l01151" name="l01151"></a><span class="lineno"> 1151</span><span class="comment">   *      &quot;Key tip: Coding for version-1 versus one version versus multiple versions.&quot;</span></div>
<div class="line"><a id="l01152" name="l01152"></a><span class="lineno"> 1152</span><span class="comment">   *</span></div>
<div class="line"><a id="l01153" name="l01153"></a><span class="lineno"> 1153</span><span class="comment">   * ### Maintenace/future ###</span></div>
<div class="line"><a id="l01154" name="l01154"></a><span class="lineno"> 1154</span><span class="comment">   * See doc header for sync_io::Blob_stream_mq_sender_impl.  Similar logic applies here.  The only thing</span></div>
<div class="line"><a id="l01155" name="l01155"></a><span class="lineno"> 1155</span><span class="comment">   * that does not apply, and is arguably simpler in our case, is that we *are* a bidirectional comm pathway;</span></div>
<div class="line"><a id="l01156" name="l01156"></a><span class="lineno"> 1156</span><span class="comment">   * there is no such thing as being a sender end without a corresponding receiver end.  So the stuff about needing</span></div>
<div class="line"><a id="l01157" name="l01157"></a><span class="lineno"> 1157</span><span class="comment">   * an API for telling us what protocol version to speak of multiple possibilities (in the hypothetical future</span></div>
<div class="line"><a id="l01158" name="l01158"></a><span class="lineno"> 1158</span><span class="comment">   * in which we&#39;d support such a thing).</span></div>
<div class="line"><a id="l01159" name="l01159"></a><span class="lineno"> 1159</span><span class="comment">   *</span></div>
<div class="line"><a id="l01160" name="l01160"></a><span class="lineno"> 1160</span><span class="comment">   * To restate: These are decisions and work for another day, though; it is not relevant until version 2 of this</span></div>
<div class="line"><a id="l01161" name="l01161"></a><span class="lineno"> 1161</span><span class="comment">   * protocol at the earliest.  That might not even happen.</span></div>
<div class="line"><a id="l01162" name="l01162"></a><span class="lineno"> 1162</span><span class="comment">   *</span></div>
<div class="line"><a id="l01163" name="l01163"></a><span class="lineno"> 1163</span><span class="comment">   * ### Thread safety ###</span></div>
<div class="line"><a id="l01164" name="l01164"></a><span class="lineno"> 1164</span><span class="comment">   * Firstly this it only touched in PEER state (and one cannot exit PEER state).  Once in PEER state:</span></div>
<div class="line"><a id="l01165" name="l01165"></a><span class="lineno"> 1165</span><span class="comment">   * First take a look at &quot;Thread safety&quot; in sync_io::Native_socket_stream class public doc header.</span></div>
<div class="line"><a id="l01166" name="l01166"></a><span class="lineno"> 1166</span><span class="comment">   * Long story short, it says that the only relevant concurrency we must allow is a receive-op being</span></div>
<div class="line"><a id="l01167" name="l01167"></a><span class="lineno"> 1167</span><span class="comment">   * invoked concurrently with a send-op while in PEER state.  Happily, Protocol_negotiator doc header</span></div>
<div class="line"><a id="l01168" name="l01168"></a><span class="lineno"> 1168</span><span class="comment">   * specifically allows the outgoing-direction APIs to be invoked concurrently with incoming-direction APIs.</span></div>
<div class="line"><a id="l01169" name="l01169"></a><span class="lineno"> 1169</span><span class="comment">   * Therefore no locking is needed.</span></div>
<div class="line"><a id="l01170" name="l01170"></a><span class="lineno"> 1170</span><span class="comment">   */</span></div>
<div class="line"><a id="l01171" name="l01171"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a393316703a666a9b022f2b879337b920"> 1171</a></span>  <a class="code hl_class" href="classipc_1_1transport_1_1Protocol__negotiator.html">Protocol_negotiator</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a393316703a666a9b022f2b879337b920">m_protocol_negotiator</a>;</div>
<div class="line"><a id="l01172" name="l01172"></a><span class="lineno"> 1172</span><span class="comment"></span> </div>
<div class="line"><a id="l01173" name="l01173"></a><span class="lineno"> 1173</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01174" name="l01174"></a><span class="lineno"> 1174</span><span class="comment">   * The `Task_engine` for #m_peer_socket.  It is necessary to construct the `Peer_socket`, but we never</span></div>
<div class="line"><a id="l01175" name="l01175"></a><span class="lineno"> 1175</span><span class="comment">   * use that guy&#39;s `-&gt;async_*()` APIs -- only non-blocking operations, essentially leveraging boost.asio&#39;s</span></div>
<div class="line"><a id="l01176" name="l01176"></a><span class="lineno"> 1176</span><span class="comment">   * portable transmission APIs but not its actual, um, async-I/O abilities in this case.  Accordingly we</span></div>
<div class="line"><a id="l01177" name="l01177"></a><span class="lineno"> 1177</span><span class="comment">   * never load any tasks onto #m_nb_task_engine and certainly never `.run()` (or `.poll()` or ...) it.</span></div>
<div class="line"><a id="l01178" name="l01178"></a><span class="lineno"> 1178</span><span class="comment">   *</span></div>
<div class="line"><a id="l01179" name="l01179"></a><span class="lineno"> 1179</span><span class="comment">   * In the `sync_io` pattern the user&#39;s outside event loop is responsible for awaiting readability/writability</span></div>
<div class="line"><a id="l01180" name="l01180"></a><span class="lineno"> 1180</span><span class="comment">   * of a guy like #m_peer_socket via our exporting of its `.native_handle()`.</span></div>
<div class="line"><a id="l01181" name="l01181"></a><span class="lineno"> 1181</span><span class="comment">   */</span></div>
<div class="line"><a id="l01182" name="l01182"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1caa342f726a273deb64317cbec8b5ea"> 1182</a></span>  flow::util::Task_engine <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1caa342f726a273deb64317cbec8b5ea">m_nb_task_engine</a>;</div>
<div class="line"><a id="l01183" name="l01183"></a><span class="lineno"> 1183</span><span class="comment"></span> </div>
<div class="line"><a id="l01184" name="l01184"></a><span class="lineno"> 1184</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01185" name="l01185"></a><span class="lineno"> 1185</span><span class="comment">   * The `Task_engine` for `m_*ev_wait_hndl_*`, unless it is replaced via replace_event_wait_handles().</span></div>
<div class="line"><a id="l01186" name="l01186"></a><span class="lineno"> 1186</span><span class="comment">   * There are 2 possibilities:</span></div>
<div class="line"><a id="l01187" name="l01187"></a><span class="lineno"> 1187</span><span class="comment">   *   - They leave this guy associated with `m_*ev_wait_hndl_*`.  Then no one shall be doing `.async_wait()` on</span></div>
<div class="line"><a id="l01188" name="l01188"></a><span class="lineno"> 1188</span><span class="comment">   *     them, and instead the user aims to perhaps use raw `[e]poll*()` on their `.native_handle()`s.</span></div>
<div class="line"><a id="l01189" name="l01189"></a><span class="lineno"> 1189</span><span class="comment">   *     We still need some `Task_engine` to construct them though, so we use this.</span></div>
<div class="line"><a id="l01190" name="l01190"></a><span class="lineno"> 1190</span><span class="comment">   *   - They use replace_event_wait_handles(), and therefore this becomes dissociated with `m_*ev_wait_hndl_*` and</span></div>
<div class="line"><a id="l01191" name="l01191"></a><span class="lineno"> 1191</span><span class="comment">   *     becomes completely unused in any fashion, period.  Then they shall probably be doing</span></div>
<div class="line"><a id="l01192" name="l01192"></a><span class="lineno"> 1192</span><span class="comment">   *     their own `.async_wait()` -- associated with their own `Task_engine` -- on `m_*ev_wait_hndl_*`.</span></div>
<div class="line"><a id="l01193" name="l01193"></a><span class="lineno"> 1193</span><span class="comment">   *</span></div>
<div class="line"><a id="l01194" name="l01194"></a><span class="lineno"> 1194</span><span class="comment">   * This is all to fulfill the `sync_io` pattern.</span></div>
<div class="line"><a id="l01195" name="l01195"></a><span class="lineno"> 1195</span><span class="comment">   */</span></div>
<div class="line"><a id="l01196" name="l01196"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0900c54fc01d0d67b94208b47fff7469"> 1196</a></span>  flow::util::Task_engine <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0900c54fc01d0d67b94208b47fff7469">m_ev_hndl_task_engine_unused</a>;</div>
<div class="line"><a id="l01197" name="l01197"></a><span class="lineno"> 1197</span><span class="comment"></span> </div>
<div class="line"><a id="l01198" name="l01198"></a><span class="lineno"> 1198</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01199" name="l01199"></a><span class="lineno"> 1199</span><span class="comment">   * The peer stream-type Unix domain socket; or null pointer if we&#39;ve detected the connection has become hosed</span></div>
<div class="line"><a id="l01200" name="l01200"></a><span class="lineno"> 1200</span><span class="comment">   * and hence closed+destroyed the boost.asio `Peer_socket`.  Note that (1) it starts non-null, and is in</span></div>
<div class="line"><a id="l01201" name="l01201"></a><span class="lineno"> 1201</span><span class="comment">   * &quot;open&quot; (FD-bearing) state from the start -- even if the NULL-state ctor was used; and (2) can only</span></div>
<div class="line"><a id="l01202" name="l01202"></a><span class="lineno"> 1202</span><span class="comment">   * become null (irreversibly so) when in PEER state, only on error.</span></div>
<div class="line"><a id="l01203" name="l01203"></a><span class="lineno"> 1203</span><span class="comment">   *   - In State::S_NULL #m_state, this is an &quot;open&quot; (FD-bearing) but unconnected socket.</span></div>
<div class="line"><a id="l01204" name="l01204"></a><span class="lineno"> 1204</span><span class="comment">   *   - In State::S_CONNECTING #m_state, this is the same socket, in the process of connecting.</span></div>
<div class="line"><a id="l01205" name="l01205"></a><span class="lineno"> 1205</span><span class="comment">   *     (If connect fails, the FD persists but goes back to just a steady-state &quot;open&quot; unconnected state.)</span></div>
<div class="line"><a id="l01206" name="l01206"></a><span class="lineno"> 1206</span><span class="comment">   *   - In State::S_PEER #m_state, this is either the same socket, now connected; or, upon a detected error in</span></div>
<div class="line"><a id="l01207" name="l01207"></a><span class="lineno"> 1207</span><span class="comment">   *     either direction, a null pointer.</span></div>
<div class="line"><a id="l01208" name="l01208"></a><span class="lineno"> 1208</span><span class="comment">   *</span></div>
<div class="line"><a id="l01209" name="l01209"></a><span class="lineno"> 1209</span><span class="comment">   * Moreover the FD cannot be replaced with another FD: if PEER-state ctor is used, then that FD is connected</span></div>
<div class="line"><a id="l01210" name="l01210"></a><span class="lineno"> 1210</span><span class="comment">   * from the start; if NULL-state ctor is used, then that FD is unconnected but may become connected (if/when)</span></div>
<div class="line"><a id="l01211" name="l01211"></a><span class="lineno"> 1211</span><span class="comment">   * State::S_PEER is reached (via async_connect()).</span></div>
<div class="line"><a id="l01212" name="l01212"></a><span class="lineno"> 1212</span><span class="comment">   *</span></div>
<div class="line"><a id="l01213" name="l01213"></a><span class="lineno"> 1213</span><span class="comment">   * `*m_peer_socket` is used *exclusively* for non-blocking calls; *never* `.async_*()`.  That conforms to</span></div>
<div class="line"><a id="l01214" name="l01214"></a><span class="lineno"> 1214</span><span class="comment">   * the `sync_io` pattern.  See #m_nb_task_engine doc header.</span></div>
<div class="line"><a id="l01215" name="l01215"></a><span class="lineno"> 1215</span><span class="comment">   *</span></div>
<div class="line"><a id="l01216" name="l01216"></a><span class="lineno"> 1216</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l01217" name="l01217"></a><span class="lineno"> 1217</span><span class="comment">   * The above facts are important -- namely that from the very start (up to an error) the FD is loaded and never</span></div>
<div class="line"><a id="l01218" name="l01218"></a><span class="lineno"> 1218</span><span class="comment">   * changes -- because the watcher FD-wrappers used in</span></div>
<div class="line"><a id="l01219" name="l01219"></a><span class="lineno"> 1219</span><span class="comment">   * the `sync_io` pattern can be simply and correctly initialized at any time and not change thereafter (</span></div>
<div class="line"><a id="l01220" name="l01220"></a><span class="lineno"> 1220</span><span class="comment">   * in terms what FD they wrap).</span></div>
<div class="line"><a id="l01221" name="l01221"></a><span class="lineno"> 1221</span><span class="comment">   *</span></div>
<div class="line"><a id="l01222" name="l01222"></a><span class="lineno"> 1222</span><span class="comment">   * As for the null-pointer state, it exists for 2 reasons which are somewhat in synergy:</span></div>
<div class="line"><a id="l01223" name="l01223"></a><span class="lineno"> 1223</span><span class="comment">   *   - It is a way of giving back the FD-resource to the kernel as early as possible.</span></div>
<div class="line"><a id="l01224" name="l01224"></a><span class="lineno"> 1224</span><span class="comment">   *     (Destroying `Peer_socket` closes the contained FD/socket.)</span></div>
<div class="line"><a id="l01225" name="l01225"></a><span class="lineno"> 1225</span><span class="comment">   *   - It is a way for the incoming-direction processing logic to inform the outgoing-direction counterpart logic</span></div>
<div class="line"><a id="l01226" name="l01226"></a><span class="lineno"> 1226</span><span class="comment">   *     that it has detected the socket is entirely hosed, in both directions (and hence no need to even try further</span></div>
<div class="line"><a id="l01227" name="l01227"></a><span class="lineno"> 1227</span><span class="comment">   *     operations on it); and vice versa.</span></div>
<div class="line"><a id="l01228" name="l01228"></a><span class="lineno"> 1228</span><span class="comment">   *</span></div>
<div class="line"><a id="l01229" name="l01229"></a><span class="lineno"> 1229</span><span class="comment">   * As to that 2nd reason: a couple of other approaches would work:</span></div>
<div class="line"><a id="l01230" name="l01230"></a><span class="lineno"> 1230</span><span class="comment">   *   - We could simply let the 2nd-to-detect-failure processing direction discover the hosedness by naively</span></div>
<div class="line"><a id="l01231" name="l01231"></a><span class="lineno"> 1231</span><span class="comment">   *     trying an operation and getting the inevitable error from the kernel (probably the same one).</span></div>
<div class="line"><a id="l01232" name="l01232"></a><span class="lineno"> 1232</span><span class="comment">   *     - This is actually a pretty good alternative approach; it might even be better:</span></div>
<div class="line"><a id="l01233" name="l01233"></a><span class="lineno"> 1233</span><span class="comment">   *       As written direction 2 will get a catch-all `S_LOW_LVL_TRANSPORT_HOSED_CANNOT_SEND` or</span></div>
<div class="line"><a id="l01234" name="l01234"></a><span class="lineno"> 1234</span><span class="comment">   *       `S_LOW_LVL_TRANSPORT_HOSED_CANNOT_RECEIVE` error; while with the alternative approach we could</span></div>
<div class="line"><a id="l01235" name="l01235"></a><span class="lineno"> 1235</span><span class="comment">   *       get the &quot;real&quot; error in both directions.  There are benefits to each approach; the alternative one</span></div>
<div class="line"><a id="l01236" name="l01236"></a><span class="lineno"> 1236</span><span class="comment">   *       provides more info when looking at just one direction, while the existing one is quicker and</span></div>
<div class="line"><a id="l01237" name="l01237"></a><span class="lineno"> 1237</span><span class="comment">   *       less entropy-laden (arguably), returns the FD/socket resource sooner, and still makes the true error</span></div>
<div class="line"><a id="l01238" name="l01238"></a><span class="lineno"> 1238</span><span class="comment">   *       available.  See to-do at the end of this doc header, as the alternative approach may carry another</span></div>
<div class="line"><a id="l01239" name="l01239"></a><span class="lineno"> 1239</span><span class="comment">   *       benefit.</span></div>
<div class="line"><a id="l01240" name="l01240"></a><span class="lineno"> 1240</span><span class="comment">   *   - We could have incoming-direction logic check #m_snd_pending_err_code/outgoing-direction check</span></div>
<div class="line"><a id="l01241" name="l01241"></a><span class="lineno"> 1241</span><span class="comment">   *     #m_rcv_pending_err_code ahead of accessing #m_peer_socket.</span></div>
<div class="line"><a id="l01242" name="l01242"></a><span class="lineno"> 1242</span><span class="comment">   *     - This idea sucks.  It breaks the intentional and important (for perf) guarantee under</span></div>
<div class="line"><a id="l01243" name="l01243"></a><span class="lineno"> 1243</span><span class="comment">   *       &quot;Thread safety&quot; in the sync_io::Native_socket_stream doc header, wherein</span></div>
<div class="line"><a id="l01244" name="l01244"></a><span class="lineno"> 1244</span><span class="comment">   *       receive-ops logic and send-ops logic may execute concurrently (as now the latter accesses some of</span></div>
<div class="line"><a id="l01245" name="l01245"></a><span class="lineno"> 1245</span><span class="comment">   *       the former&#39;s data and vice versa).</span></div>
<div class="line"><a id="l01246" name="l01246"></a><span class="lineno"> 1246</span><span class="comment">   *</span></div>
<div class="line"><a id="l01247" name="l01247"></a><span class="lineno"> 1247</span><span class="comment">   * ### Concurrency, synchronization ###</span></div>
<div class="line"><a id="l01248" name="l01248"></a><span class="lineno"> 1248</span><span class="comment">   * That brings us to the key discussion of concurrency protection: #m_peer_socket is the</span></div>
<div class="line"><a id="l01249" name="l01249"></a><span class="lineno"> 1249</span><span class="comment">   * *only* non-`const`-accessed datum in `*this` that may be accessed concurrently by receive-ops methods</span></div>
<div class="line"><a id="l01250" name="l01250"></a><span class="lineno"> 1250</span><span class="comment">   * and send-ops methods.  Namely: send-ops are started by `start_send_*_ops()`; receive-ops are started by</span></div>
<div class="line"><a id="l01251" name="l01251"></a><span class="lineno"> 1251</span><span class="comment">   * `start_receive_*_ops()`; in PEER state all logic to do with sending can occur entirely concurrently with all</span></div>
<div class="line"><a id="l01252" name="l01252"></a><span class="lineno"> 1252</span><span class="comment">   * logic to do with receiving.  Except, however, they both use #m_peer_socket -- for *non-blocking calls only!* --</span></div>
<div class="line"><a id="l01253" name="l01253"></a><span class="lineno"> 1253</span><span class="comment">   * as #m_peer_socket is bidirectional.  In particular, for example, `m_peer_socket-&gt;read_some()` might execute</span></div>
<div class="line"><a id="l01254" name="l01254"></a><span class="lineno"> 1254</span><span class="comment">   * concurrently to `m_peer_socket-&gt;write_some()`.  In addition, #m_peer_socket pointer might be nullified (due to</span></div>
<div class="line"><a id="l01255" name="l01255"></a><span class="lineno"> 1255</span><span class="comment">   * error) by one direction&#39;s logic, while the other is trying to dereference it and execute a method.</span></div>
<div class="line"><a id="l01256" name="l01256"></a><span class="lineno"> 1256</span><span class="comment">   *</span></div>
<div class="line"><a id="l01257" name="l01257"></a><span class="lineno"> 1257</span><span class="comment">   * This is resolved by our locking #m_peer_socket_mutex, albeit in a very tight critical section that always</span></div>
<div class="line"><a id="l01258" name="l01258"></a><span class="lineno"> 1258</span><span class="comment">   * looks like:</span></div>
<div class="line"><a id="l01259" name="l01259"></a><span class="lineno"> 1259</span><span class="comment">   *   -# Lock mutex.</span></div>
<div class="line"><a id="l01260" name="l01260"></a><span class="lineno"> 1260</span><span class="comment">   *   -# Check if it&#39;s null; if so unlock/exit algorithm.  Else:</span></div>
<div class="line"><a id="l01261" name="l01261"></a><span class="lineno"> 1261</span><span class="comment">   *   -# Attempt synchronous, non-blocking operation on dereferenced pointer.</span></div>
<div class="line"><a id="l01262" name="l01262"></a><span class="lineno"> 1262</span><span class="comment">   *   -# If it exposed socket error, nullify pointer.</span></div>
<div class="line"><a id="l01263" name="l01263"></a><span class="lineno"> 1263</span><span class="comment">   *   -# Unlock mutex.</span></div>
<div class="line"><a id="l01264" name="l01264"></a><span class="lineno"> 1264</span><span class="comment">   *</span></div>
<div class="line"><a id="l01265" name="l01265"></a><span class="lineno"> 1265</span><span class="comment">   * It&#39;s tight, so lock contention should be minimal.  Also no other mutex is locked inside such a critical</span></div>
<div class="line"><a id="l01266" name="l01266"></a><span class="lineno"> 1266</span><span class="comment">   * section, so deadlock chance is nil.  However see the following to-do for an alternative approach.</span></div>
<div class="line"><a id="l01267" name="l01267"></a><span class="lineno"> 1267</span><span class="comment">   *</span></div>
<div class="line"><a id="l01268" name="l01268"></a><span class="lineno"> 1268</span><span class="comment">   * @todo `Peer_socket m_peer_socket` synchronous-read ops (`read_some()`) are actually</span></div>
<div class="line"><a id="l01269" name="l01269"></a><span class="lineno"> 1269</span><span class="comment">   * documented in boost::asio to be thread-safe against concurrently invoked synchronous-write ops</span></div>
<div class="line"><a id="l01270" name="l01270"></a><span class="lineno"> 1270</span><span class="comment">   * (`write_some()`), as are OS calls `&quot;::recvmsg()&quot;`, `&quot;::sendmsg()&quot;`; therefore for possible perf bump</span></div>
<div class="line"><a id="l01271" name="l01271"></a><span class="lineno"> 1271</span><span class="comment">   * consider never nullifying Impl::m_peer_socket; eliminating Impl::m_peer_socket_mutex; and</span></div>
<div class="line"><a id="l01272" name="l01272"></a><span class="lineno"> 1272</span><span class="comment">   * letting each direction&#39;s logic discover any socket-error independently.  (But, at the moment,</span></div>
<div class="line"><a id="l01273" name="l01273"></a><span class="lineno"> 1273</span><span class="comment">   * `m_peer_socket_mutex` also covers mirror-guy #m_ev_wait_hndl_peer_socket, so that must be worked out.)</span></div>
<div class="line"><a id="l01274" name="l01274"></a><span class="lineno"> 1274</span><span class="comment">   *</span></div>
<div class="line"><a id="l01275" name="l01275"></a><span class="lineno"> 1275</span><span class="comment">   * To be clear, the text above</span></div>
<div class="line"><a id="l01276" name="l01276"></a><span class="lineno"> 1276</span><span class="comment">   * w/r/t concurrency/synchronization says `-&gt;write_some()` and `-&gt;read_some()` might execute concurrently --</span></div>
<div class="line"><a id="l01277" name="l01277"></a><span class="lineno"> 1277</span><span class="comment">   * but boost.asio docs (`basic_stream_socket` page) indicate that is actually okay; and implies</span></div>
<div class="line"><a id="l01278" name="l01278"></a><span class="lineno"> 1278</span><span class="comment">   * the same about underlying OS calls (which includes `readmsg()` and `writemsg()` which we use when</span></div>
<div class="line"><a id="l01279" name="l01279"></a><span class="lineno"> 1279</span><span class="comment">   * `Native_handle` transmission is needed).  Now, the nullification versus dereferencing of the `unique_ptr`</span></div>
<div class="line"><a id="l01280" name="l01280"></a><span class="lineno"> 1280</span><span class="comment">   * wrapping `m_peer_socket`: that is indeed not thread-safe, which is why we&#39;d need to also get rid of that method</span></div>
<div class="line"><a id="l01281" name="l01281"></a><span class="lineno"> 1281</span><span class="comment">   * of communicating socket-hosed state from one direction to the other.  However, as we wrote above, the</span></div>
<div class="line"><a id="l01282" name="l01282"></a><span class="lineno"> 1282</span><span class="comment">   * alternate approach, where each direction discovers the socket error independently, would be compatible</span></div>
<div class="line"><a id="l01283" name="l01283"></a><span class="lineno"> 1283</span><span class="comment">   * with `m_peer_socket` not needing to be a `unique_ptr` at all.  That said the socket would not be given</span></div>
<div class="line"><a id="l01284" name="l01284"></a><span class="lineno"> 1284</span><span class="comment">   * back to the system as early (potentially) -- note that boost.asio `close()` is noted to not be</span></div>
<div class="line"><a id="l01285" name="l01285"></a><span class="lineno"> 1285</span><span class="comment">   * safe against concurrent reads/writes -- and in general the approach &quot;feels&quot; more entropy-laden.</span></div>
<div class="line"><a id="l01286" name="l01286"></a><span class="lineno"> 1286</span><span class="comment">   * I (ygoldfel) must say, though; it does sound entirely viable nevertheless; and it would be a limited change</span></div>
<div class="line"><a id="l01287" name="l01287"></a><span class="lineno"> 1287</span><span class="comment">   * that would also eliminate error::Code::S_LOW_LVL_TRANSPORT_HOSED_CANNOT_SEND</span></div>
<div class="line"><a id="l01288" name="l01288"></a><span class="lineno"> 1288</span><span class="comment">   * and error::Code::S_LOW_LVL_TRANSPORT_HOSED_CANNOT_RECEIVE.  One could even argue it is elegant, in that</span></div>
<div class="line"><a id="l01289" name="l01289"></a><span class="lineno"> 1289</span><span class="comment">   * it decouples the 2 directions as much as humanly possible, to the point of even using the kernel&#39;s support</span></div>
<div class="line"><a id="l01290" name="l01290"></a><span class="lineno"> 1290</span><span class="comment">   * for it.  (Last note: the boost.asio docs single out `connect()`, `shutdown()`, `send()`, `receive()`</span></div>
<div class="line"><a id="l01291" name="l01291"></a><span class="lineno"> 1291</span><span class="comment">   * as okay to invoke concurrently; not `read_some()` and `write_some()`; but I very strongly suspect</span></div>
<div class="line"><a id="l01292" name="l01292"></a><span class="lineno"> 1292</span><span class="comment">   * this is only an omission, perhaps due to `*_some()` appearing for uniformity in a boost.asio overhaul</span></div>
<div class="line"><a id="l01293" name="l01293"></a><span class="lineno"> 1293</span><span class="comment">   * after those docs were written; in the source it is clear they invoke the same exact stuff.  Googling shows,</span></div>
<div class="line"><a id="l01294" name="l01294"></a><span class="lineno"> 1294</span><span class="comment">   * generally, the underlying OS calls including `*msg()` are thread-safe to use in this manner also.)</span></div>
<div class="line"><a id="l01295" name="l01295"></a><span class="lineno"> 1295</span><span class="comment">   */</span></div>
<div class="line"><a id="l01296" name="l01296"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a42aab631e9c70bfaa53764309adfe37c"> 1296</a></span>  boost::movelib::unique_ptr&lt;asio_local_stream_socket::Peer_socket&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a42aab631e9c70bfaa53764309adfe37c">m_peer_socket</a>;</div>
<div class="line"><a id="l01297" name="l01297"></a><span class="lineno"> 1297</span><span class="comment"></span> </div>
<div class="line"><a id="l01298" name="l01298"></a><span class="lineno"> 1298</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01299" name="l01299"></a><span class="lineno"> 1299</span><span class="comment">   * Descriptor waitable by outside event loop async-waits -- storing the same `Native_handle` as (and thus being</span></div>
<div class="line"><a id="l01300" name="l01300"></a><span class="lineno"> 1300</span><span class="comment">   * used to wait on events from) #m_peer_socket.</span></div>
<div class="line"><a id="l01301" name="l01301"></a><span class="lineno"> 1301</span><span class="comment">   *</span></div>
<div class="line"><a id="l01302" name="l01302"></a><span class="lineno"> 1302</span><span class="comment">   * Protected by #m_peer_socket_mutex, along with #m_peer_socket.  To be accessed only if an error hasn&#39;t</span></div>
<div class="line"><a id="l01303" name="l01303"></a><span class="lineno"> 1303</span><span class="comment">   * nullified #m_peer_socket since the last critical section.  Now, &quot;accessed&quot; *always* (once set up)</span></div>
<div class="line"><a id="l01304" name="l01304"></a><span class="lineno"> 1304</span><span class="comment">   * means calling `m_*_ev_wait_wait_func` with this guy as the 1st arg; it can be pictured as a `sync_io`</span></div>
<div class="line"><a id="l01305" name="l01305"></a><span class="lineno"> 1305</span><span class="comment">   * equivalent of `m_peer_socket-&gt;async_wait()`.  However it does mean the `*this` user must be careful</span></div>
<div class="line"><a id="l01306" name="l01306"></a><span class="lineno"> 1306</span><span class="comment">   * not to lock something in that function that is already locked when they call `(*on_active_ev_func)()` --</span></div>
<div class="line"><a id="l01307" name="l01307"></a><span class="lineno"> 1307</span><span class="comment">   * that would cause a deadlock -- and if it&#39;s a recursive mutex, then they risk an AB/BA deadlock.</span></div>
<div class="line"><a id="l01308" name="l01308"></a><span class="lineno"> 1308</span><span class="comment">   *</span></div>
<div class="line"><a id="l01309" name="l01309"></a><span class="lineno"> 1309</span><span class="comment">   * @see #m_timer_worker for more info.</span></div>
<div class="line"><a id="l01310" name="l01310"></a><span class="lineno"> 1310</span><span class="comment">   */</span></div>
<div class="line"><a id="l01311" name="l01311"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ac6a82eda9256cba45f3b5365d79355"> 1311</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Asio__waitable__native__handle.html">util::sync_io::Asio_waitable_native_handle</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ac6a82eda9256cba45f3b5365d79355">m_ev_wait_hndl_peer_socket</a>;</div>
<div class="line"><a id="l01312" name="l01312"></a><span class="lineno"> 1312</span><span class="comment"></span> </div>
<div class="line"><a id="l01313" name="l01313"></a><span class="lineno"> 1313</span><span class="comment">  /// Protects #m_peer_socket and its bro #m_ev_wait_hndl_peer_socket.</span></div>
<div class="line"><a id="l01314" name="l01314"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abc7d2b14208ed2b8c0add0c26f7fbf27"> 1314</a></span><span class="comment"></span>  flow::util::Mutex_non_recursive <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abc7d2b14208ed2b8c0add0c26f7fbf27">m_peer_socket_mutex</a>;</div>
<div class="line"><a id="l01315" name="l01315"></a><span class="lineno"> 1315</span><span class="comment"></span> </div>
<div class="line"><a id="l01316" name="l01316"></a><span class="lineno"> 1316</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01317" name="l01317"></a><span class="lineno"> 1317</span><span class="comment">   * As typical in timer-needing `sync_io`-pattern-implementing objects, maintains a thread exclusively for</span></div>
<div class="line"><a id="l01318" name="l01318"></a><span class="lineno"> 1318</span><span class="comment">   * `Timer` wait completion handlers which ferry timer-fired events to internal IPC-mechanisms waitable</span></div>
<div class="line"><a id="l01319" name="l01319"></a><span class="lineno"> 1319</span><span class="comment">   * by the `sync_io`-pattern-using outside event loop.  In our case we (optionally) maintain the auto-ping timer</span></div>
<div class="line"><a id="l01320" name="l01320"></a><span class="lineno"> 1320</span><span class="comment">   * (send direction) and idle timer (receive direction).</span></div>
<div class="line"><a id="l01321" name="l01321"></a><span class="lineno"> 1321</span><span class="comment">   *</span></div>
<div class="line"><a id="l01322" name="l01322"></a><span class="lineno"> 1322</span><span class="comment">   * @see util::sync_io::Timer_event_emitter doc header for design/rationale discussion.</span></div>
<div class="line"><a id="l01323" name="l01323"></a><span class="lineno"> 1323</span><span class="comment">   */</span></div>
<div class="line"><a id="l01324" name="l01324"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a54c3fdde2cf99fda314ee3387f70a02e"> 1324</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">util::sync_io::Timer_event_emitter</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a54c3fdde2cf99fda314ee3387f70a02e">m_timer_worker</a>;</div>
<div class="line"><a id="l01325" name="l01325"></a><span class="lineno"> 1325</span> </div>
<div class="line"><a id="l01326" name="l01326"></a><span class="lineno"> 1326</span>  <span class="comment">// Connect-ops data.</span></div>
<div class="line"><a id="l01327" name="l01327"></a><span class="lineno"> 1327</span><span class="comment"></span> </div>
<div class="line"><a id="l01328" name="l01328"></a><span class="lineno"> 1328</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01329" name="l01329"></a><span class="lineno"> 1329</span><span class="comment">   * Event loop used exclusively by sync_connect() which as needed `-&gt;start()`s a short-lived thread and `-&gt;stop()`s it</span></div>
<div class="line"><a id="l01330" name="l01330"></a><span class="lineno"> 1330</span><span class="comment">   * before returning, in case async_connect() does not complete synchronously.  Null in PEER state; non-null in NULL</span></div>
<div class="line"><a id="l01331" name="l01331"></a><span class="lineno"> 1331</span><span class="comment">   * state (when sync_connect() might be called and not no-op).</span></div>
<div class="line"><a id="l01332" name="l01332"></a><span class="lineno"> 1332</span><span class="comment">   *</span></div>
<div class="line"><a id="l01333" name="l01333"></a><span class="lineno"> 1333</span><span class="comment">   * See &quot;Connect-ops impl design&quot; in class doc header for key background discussion of sync_connect() et al.</span></div>
<div class="line"><a id="l01334" name="l01334"></a><span class="lineno"> 1334</span><span class="comment">   */</span></div>
<div class="line"><a id="l01335" name="l01335"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae094bf64dda8f6c6e013400a77fd1343"> 1335</a></span>  std::optional&lt;flow::async::Single_thread_task_loop&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae094bf64dda8f6c6e013400a77fd1343">m_conn_async_worker</a>;</div>
<div class="line"><a id="l01336" name="l01336"></a><span class="lineno"> 1336</span><span class="comment"></span> </div>
<div class="line"><a id="l01337" name="l01337"></a><span class="lineno"> 1337</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01338" name="l01338"></a><span class="lineno"> 1338</span><span class="comment">   * This is to (#m_peer_socket, #m_conn_async_worker) what #m_ev_wait_hndl_peer_socket is to (#m_peer_socket,</span></div>
<div class="line"><a id="l01339" name="l01339"></a><span class="lineno"> 1339</span><span class="comment">   * transport::Native_socket_stream::Impl::m_worker), respectively.  Thus it stores yet another copy of</span></div>
<div class="line"><a id="l01340" name="l01340"></a><span class="lineno"> 1340</span><span class="comment">   * `m_peer_socket-&gt;native_handle()` but associated with `m_conn_async_worker-&gt;task_engine()`; so that</span></div>
<div class="line"><a id="l01341" name="l01341"></a><span class="lineno"> 1341</span><span class="comment">   * async_connect() -- if it needs to execute an async-wait -- can (via `sync_io` pattern) make use of</span></div>
<div class="line"><a id="l01342" name="l01342"></a><span class="lineno"> 1342</span><span class="comment">   * `m_conn_ev_wait_hndl_peer_socket-&gt;async_wait(F)`, and completion handler `F()` shall be posted onto the</span></div>
<div class="line"><a id="l01343" name="l01343"></a><span class="lineno"> 1343</span><span class="comment">   * short-lived thread resulting from `m_conn_async_worker-&gt;start()` in sync_connect().</span></div>
<div class="line"><a id="l01344" name="l01344"></a><span class="lineno"> 1344</span><span class="comment">   *</span></div>
<div class="line"><a id="l01345" name="l01345"></a><span class="lineno"> 1345</span><span class="comment">   * Null if and only if #m_conn_async_worker is null.</span></div>
<div class="line"><a id="l01346" name="l01346"></a><span class="lineno"> 1346</span><span class="comment">   * </span></div>
<div class="line"><a id="l01347" name="l01347"></a><span class="lineno"> 1347</span><span class="comment">   * See &quot;Connect-ops impl design&quot; in class doc header for key background discussion of sync_connect() et al.</span></div>
<div class="line"><a id="l01348" name="l01348"></a><span class="lineno"> 1348</span><span class="comment">   *</span></div>
<div class="line"><a id="l01349" name="l01349"></a><span class="lineno"> 1349</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l01350" name="l01350"></a><span class="lineno"> 1350</span><span class="comment">   * It is also possible to instead just use #m_ev_wait_hndl_peer_socket for the connect-ops `sync_io`-pattern</span></div>
<div class="line"><a id="l01351" name="l01351"></a><span class="lineno"> 1351</span><span class="comment">   * setup, along with using it for send-ops and receive-ops.  However, while storing marginally less state,</span></div>
<div class="line"><a id="l01352" name="l01352"></a><span class="lineno"> 1352</span><span class="comment">   * it is pretty annoying in other ways: replace_event_wait_handles() to set up future send-ops and receive-ops</span></div>
<div class="line"><a id="l01353" name="l01353"></a><span class="lineno"> 1353</span><span class="comment">   * can happen at any time, including before sync_connect(); so sync_connect() would need to save</span></div>
<div class="line"><a id="l01354" name="l01354"></a><span class="lineno"> 1354</span><span class="comment">   * #m_ev_wait_hndl_peer_socket, then re-associate it with #m_conn_async_worker, then restore it.  Whereas by</span></div>
<div class="line"><a id="l01355" name="l01355"></a><span class="lineno"> 1355</span><span class="comment">   * decoupling as we do here, we separate the NULL-state and PEER-state algorithms cleanly and need to worry</span></div>
<div class="line"><a id="l01356" name="l01356"></a><span class="lineno"> 1356</span><span class="comment">   * about that stuff.</span></div>
<div class="line"><a id="l01357" name="l01357"></a><span class="lineno"> 1357</span><span class="comment">   *</span></div>
<div class="line"><a id="l01358" name="l01358"></a><span class="lineno"> 1358</span><span class="comment">   * (Maintenance note: If/when -- as speculated in class doc header section &quot;Connect-ops impl design&quot; -- we make</span></div>
<div class="line"><a id="l01359" name="l01359"></a><span class="lineno"> 1359</span><span class="comment">   * start_connect_ops() and async_connect() public at some point, then probably it&#39;ll be best to indeed</span></div>
<div class="line"><a id="l01360" name="l01360"></a><span class="lineno"> 1360</span><span class="comment">   * eliminate `m_conn_ev_wait_hndl_peer_socket` and use `m_ev_wait_hndl_peer_socket` for all the ops, including</span></div>
<div class="line"><a id="l01361" name="l01361"></a><span class="lineno"> 1361</span><span class="comment">   * having replace_event_wait_handles() handle connect-ops stuff in addition to send-ops and receive-ops.  Now</span></div>
<div class="line"><a id="l01362" name="l01362"></a><span class="lineno"> 1362</span><span class="comment">   * the user will be in charge of providing async-waiting machinery for connect-ops per normal `sync_op` pattern,</span></div>
<div class="line"><a id="l01363" name="l01363"></a><span class="lineno"> 1363</span><span class="comment">   * as opposed to the existing situation where we manage that internally to `*this`.)</span></div>
<div class="line"><a id="l01364" name="l01364"></a><span class="lineno"> 1364</span><span class="comment">   */</span></div>
<div class="line"><a id="l01365" name="l01365"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa2d79438a470aa94feb2fbbcd72dc629"> 1365</a></span>  std::optional&lt;util::sync_io::Asio_waitable_native_handle&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa2d79438a470aa94feb2fbbcd72dc629">m_conn_ev_wait_hndl_peer_socket</a>;</div>
<div class="line"><a id="l01366" name="l01366"></a><span class="lineno"> 1366</span><span class="comment"></span> </div>
<div class="line"><a id="l01367" name="l01367"></a><span class="lineno"> 1367</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01368" name="l01368"></a><span class="lineno"> 1368</span><span class="comment">   * Function (set forever in start_connect_ops()) through which we invoke the outside event loop&#39;s</span></div>
<div class="line"><a id="l01369" name="l01369"></a><span class="lineno"> 1369</span><span class="comment">   * async-wait facility for descriptors/events relevant to connect-ops.  See util::sync_io::Event_wait_func</span></div>
<div class="line"><a id="l01370" name="l01370"></a><span class="lineno"> 1370</span><span class="comment">   * doc header for a refresher on this mechanic.</span></div>
<div class="line"><a id="l01371" name="l01371"></a><span class="lineno"> 1371</span><span class="comment">   */</span></div>
<div class="line"><a id="l01372" name="l01372"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa020c49ecb9fb12fb554342f096b9822"> 1372</a></span>  <a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa020c49ecb9fb12fb554342f096b9822">m_conn_ev_wait_func</a>;</div>
<div class="line"><a id="l01373" name="l01373"></a><span class="lineno"> 1373</span> </div>
<div class="line"><a id="l01374" name="l01374"></a><span class="lineno"> 1374</span>  <span class="comment">// Outgoing-direction data.</span></div>
<div class="line"><a id="l01375" name="l01375"></a><span class="lineno"> 1375</span><span class="comment"></span> </div>
<div class="line"><a id="l01376" name="l01376"></a><span class="lineno"> 1376</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01377" name="l01377"></a><span class="lineno"> 1377</span><span class="comment">   * Queue storing (at head) the currently in-progress async write-op of a Snd_low_lvl_payload; followed by</span></div>
<div class="line"><a id="l01378" name="l01378"></a><span class="lineno"> 1378</span><span class="comment">   * the payloads that should be written after that completes, in order.</span></div>
<div class="line"><a id="l01379" name="l01379"></a><span class="lineno"> 1379</span><span class="comment">   *</span></div>
<div class="line"><a id="l01380" name="l01380"></a><span class="lineno"> 1380</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.  In that state only touched if would-block is</span></div>
<div class="line"><a id="l01381" name="l01381"></a><span class="lineno"> 1381</span><span class="comment">   * encountered in... well, see Snd_low_lvl_payload doc header.</span></div>
<div class="line"><a id="l01382" name="l01382"></a><span class="lineno"> 1382</span><span class="comment">   */</span></div>
<div class="line"><a id="l01383" name="l01383"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1af9eb83b9afee25ba153a2ca066858d"> 1383</a></span>  std::queue&lt;Snd_low_lvl_payload::Ptr&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1af9eb83b9afee25ba153a2ca066858d">m_snd_pending_payloads_q</a>;</div>
<div class="line"><a id="l01384" name="l01384"></a><span class="lineno"> 1384</span><span class="comment"></span> </div>
<div class="line"><a id="l01385" name="l01385"></a><span class="lineno"> 1385</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01386" name="l01386"></a><span class="lineno"> 1386</span><span class="comment">   * The first and only connection-hosing error condition detected when attempting to low-level-write on</span></div>
<div class="line"><a id="l01387" name="l01387"></a><span class="lineno"> 1387</span><span class="comment">   * #m_peer_socket; or falsy if no such error has yet been detected.  Among possible other uses, it is returned</span></div>
<div class="line"><a id="l01388" name="l01388"></a><span class="lineno"> 1388</span><span class="comment">   * by send_native_handle() and the completion handler of async_end_sending().</span></div>
<div class="line"><a id="l01389" name="l01389"></a><span class="lineno"> 1389</span><span class="comment">   *</span></div>
<div class="line"><a id="l01390" name="l01390"></a><span class="lineno"> 1390</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01391" name="l01391"></a><span class="lineno"> 1391</span><span class="comment">   */</span></div>
<div class="line"><a id="l01392" name="l01392"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0257a7903bff120aa1523f8de04bccf7"> 1392</a></span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0257a7903bff120aa1523f8de04bccf7">m_snd_pending_err_code</a>;</div>
<div class="line"><a id="l01393" name="l01393"></a><span class="lineno"> 1393</span><span class="comment"></span> </div>
<div class="line"><a id="l01394" name="l01394"></a><span class="lineno"> 1394</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01395" name="l01395"></a><span class="lineno"> 1395</span><span class="comment">   * `false` at start; set to `true` forever on the first `*end_sending()` invocation;</span></div>
<div class="line"><a id="l01396" name="l01396"></a><span class="lineno"> 1396</span><span class="comment">   * `true` will prevent any subsequent send_native_handle()/send_blob() calls from proceeding.</span></div>
<div class="line"><a id="l01397" name="l01397"></a><span class="lineno"> 1397</span><span class="comment">   * See class doc header impl section for design discussion.</span></div>
<div class="line"><a id="l01398" name="l01398"></a><span class="lineno"> 1398</span><span class="comment">   *</span></div>
<div class="line"><a id="l01399" name="l01399"></a><span class="lineno"> 1399</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01400" name="l01400"></a><span class="lineno"> 1400</span><span class="comment">   */</span></div>
<div class="line"><a id="l01401" name="l01401"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#acfefc83c990b1b6cd903f5ad323e5dfa"> 1401</a></span>  <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#acfefc83c990b1b6cd903f5ad323e5dfa">m_snd_finished</a>;</div>
<div class="line"><a id="l01402" name="l01402"></a><span class="lineno"> 1402</span><span class="comment"></span> </div>
<div class="line"><a id="l01403" name="l01403"></a><span class="lineno"> 1403</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01404" name="l01404"></a><span class="lineno"> 1404</span><span class="comment">   * Function passed to async_end_sending(), if it returned `true` and was unable to synchronously flush everything</span></div>
<div class="line"><a id="l01405" name="l01405"></a><span class="lineno"> 1405</span><span class="comment">   * including the graceful-close itself (synchronously detecting new or previous pipe-hosing error *does* entail</span></div>
<div class="line"><a id="l01406" name="l01406"></a><span class="lineno"> 1406</span><span class="comment">   * flushing everything); otherwise `.empty()`.  It&#39;s the completion handler of that graceful-close-send API.</span></div>
<div class="line"><a id="l01407" name="l01407"></a><span class="lineno"> 1407</span><span class="comment">   *</span></div>
<div class="line"><a id="l01408" name="l01408"></a><span class="lineno"> 1408</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01409" name="l01409"></a><span class="lineno"> 1409</span><span class="comment">   */</span></div>
<div class="line"><a id="l01410" name="l01410"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a92372b2da3a4bdccda23b27b2865f01d"> 1410</a></span>  flow::async::Task_asio_err <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a92372b2da3a4bdccda23b27b2865f01d">m_snd_pending_on_last_send_done_func_or_empty</a>;</div>
<div class="line"><a id="l01411" name="l01411"></a><span class="lineno"> 1411</span><span class="comment"></span> </div>
<div class="line"><a id="l01412" name="l01412"></a><span class="lineno"> 1412</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01413" name="l01413"></a><span class="lineno"> 1413</span><span class="comment">   * Equals `zero()` before auto_ping(); immutably equals `period` (auto_ping() arg) subsequently to that first</span></div>
<div class="line"><a id="l01414" name="l01414"></a><span class="lineno"> 1414</span><span class="comment">   * successful call (if any).</span></div>
<div class="line"><a id="l01415" name="l01415"></a><span class="lineno"> 1415</span><span class="comment">   *</span></div>
<div class="line"><a id="l01416" name="l01416"></a><span class="lineno"> 1416</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01417" name="l01417"></a><span class="lineno"> 1417</span><span class="comment">   */</span></div>
<div class="line"><a id="l01418" name="l01418"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4cb5d8ce6fa402c2cbaf27ec9654277c"> 1418</a></span>  <a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4cb5d8ce6fa402c2cbaf27ec9654277c">m_snd_auto_ping_period</a>;</div>
<div class="line"><a id="l01419" name="l01419"></a><span class="lineno"> 1419</span><span class="comment"></span> </div>
<div class="line"><a id="l01420" name="l01420"></a><span class="lineno"> 1420</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01421" name="l01421"></a><span class="lineno"> 1421</span><span class="comment">   * Timer that fires snd_on_ev_auto_ping_now_timer_fired() (which sends an auto-ping) and is always</span></div>
<div class="line"><a id="l01422" name="l01422"></a><span class="lineno"> 1422</span><span class="comment">   * scheduled to fire #m_snd_auto_ping_period after the last send (send_native_handle(),  auto_ping(),</span></div>
<div class="line"><a id="l01423" name="l01423"></a><span class="lineno"> 1423</span><span class="comment">   * snd_on_ev_auto_ping_now_timer_fired() itself).  Each of these calls indicates a send occurs, hence</span></div>
<div class="line"><a id="l01424" name="l01424"></a><span class="lineno"> 1424</span><span class="comment">   * at worst the pipe will be idle (in need of auto-ping) in #m_snd_auto_ping_period.  Note that</span></div>
<div class="line"><a id="l01425" name="l01425"></a><span class="lineno"> 1425</span><span class="comment">   * `*end_sending()`, while also sending bytes, does not schedule #m_snd_auto_ping_timer, as `*end_sending()`</span></div>
<div class="line"><a id="l01426" name="l01426"></a><span class="lineno"> 1426</span><span class="comment">   * closes the conceptual pipe, and there is no need for auto-pinging (see Native_handle_receiver::idle_timer_run()).</span></div>
<div class="line"><a id="l01427" name="l01427"></a><span class="lineno"> 1427</span><span class="comment">   *</span></div>
<div class="line"><a id="l01428" name="l01428"></a><span class="lineno"> 1428</span><span class="comment">   * Since we implement `sync_io` pattern, the timer is obtained from, and used via, util::sync_io::Timer_event_emitter</span></div>
<div class="line"><a id="l01429" name="l01429"></a><span class="lineno"> 1429</span><span class="comment">   * #m_timer_worker.  See that member&#39;s doc header for more info.</span></div>
<div class="line"><a id="l01430" name="l01430"></a><span class="lineno"> 1430</span><span class="comment">   *</span></div>
<div class="line"><a id="l01431" name="l01431"></a><span class="lineno"> 1431</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01432" name="l01432"></a><span class="lineno"> 1432</span><span class="comment">   */</span></div>
<div class="line"><a id="l01433" name="l01433"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a311a0641a1da83530311e16845105c2c"> 1433</a></span>  flow::util::Timer <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a311a0641a1da83530311e16845105c2c">m_snd_auto_ping_timer</a>;</div>
<div class="line"><a id="l01434" name="l01434"></a><span class="lineno"> 1434</span><span class="comment"></span> </div>
<div class="line"><a id="l01435" name="l01435"></a><span class="lineno"> 1435</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01436" name="l01436"></a><span class="lineno"> 1436</span><span class="comment">   * Read-end of IPC-mechanism used by #m_timer_worker to ferry timer-fired events from #m_snd_auto_ping_timer</span></div>
<div class="line"><a id="l01437" name="l01437"></a><span class="lineno"> 1437</span><span class="comment">   * to `sync_io` outside async-wait to our actual on-timer-fired handler logic.</span></div>
<div class="line"><a id="l01438" name="l01438"></a><span class="lineno"> 1438</span><span class="comment">   *</span></div>
<div class="line"><a id="l01439" name="l01439"></a><span class="lineno"> 1439</span><span class="comment">   * @see #m_timer_worker for more info.</span></div>
<div class="line"><a id="l01440" name="l01440"></a><span class="lineno"> 1440</span><span class="comment">   */</span></div>
<div class="line"><a id="l01441" name="l01441"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3116d5b66bf35bec158905bbde4f6854"> 1441</a></span>  <a class="code hl_typedef" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">util::sync_io::Timer_event_emitter::Timer_fired_read_end</a>* <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3116d5b66bf35bec158905bbde4f6854">m_snd_auto_ping_timer_fired_peer</a>;</div>
<div class="line"><a id="l01442" name="l01442"></a><span class="lineno"> 1442</span><span class="comment"></span> </div>
<div class="line"><a id="l01443" name="l01443"></a><span class="lineno"> 1443</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01444" name="l01444"></a><span class="lineno"> 1444</span><span class="comment">   * Descriptor waitable by outside event loop async-waits -- storing the same `Native_handle` as (and thus being</span></div>
<div class="line"><a id="l01445" name="l01445"></a><span class="lineno"> 1445</span><span class="comment">   * used to wait on events from) #m_snd_auto_ping_timer_fired_peer.</span></div>
<div class="line"><a id="l01446" name="l01446"></a><span class="lineno"> 1446</span><span class="comment">   *</span></div>
<div class="line"><a id="l01447" name="l01447"></a><span class="lineno"> 1447</span><span class="comment">   * @see #m_timer_worker for more info.</span></div>
<div class="line"><a id="l01448" name="l01448"></a><span class="lineno"> 1448</span><span class="comment">   */</span></div>
<div class="line"><a id="l01449" name="l01449"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a459618a64d769ba8798a6380e9292181"> 1449</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Asio__waitable__native__handle.html">util::sync_io::Asio_waitable_native_handle</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a459618a64d769ba8798a6380e9292181">m_snd_ev_wait_hndl_auto_ping_timer_fired_peer</a>;</div>
<div class="line"><a id="l01450" name="l01450"></a><span class="lineno"> 1450</span><span class="comment"></span> </div>
<div class="line"><a id="l01451" name="l01451"></a><span class="lineno"> 1451</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01452" name="l01452"></a><span class="lineno"> 1452</span><span class="comment">   * Function (set forever in `start_send_*_ops()`) through which we invoke the</span></div>
<div class="line"><a id="l01453" name="l01453"></a><span class="lineno"> 1453</span><span class="comment">   * outside event loop&#39;s async-wait facility for descriptors/events relevant to send-ops.</span></div>
<div class="line"><a id="l01454" name="l01454"></a><span class="lineno"> 1454</span><span class="comment">   * See util::sync_io::Event_wait_func doc header for a refresher on this mechanic.</span></div>
<div class="line"><a id="l01455" name="l01455"></a><span class="lineno"> 1455</span><span class="comment">   */</span></div>
<div class="line"><a id="l01456" name="l01456"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abd4d8d43776c3956c6896ca721e95dab"> 1456</a></span>  <a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abd4d8d43776c3956c6896ca721e95dab">m_snd_ev_wait_func</a>;</div>
<div class="line"><a id="l01457" name="l01457"></a><span class="lineno"> 1457</span> </div>
<div class="line"><a id="l01458" name="l01458"></a><span class="lineno"> 1458</span>  <span class="comment">// Incoming-direction data.</span></div>
<div class="line"><a id="l01459" name="l01459"></a><span class="lineno"> 1459</span><span class="comment"></span> </div>
<div class="line"><a id="l01460" name="l01460"></a><span class="lineno"> 1460</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01461" name="l01461"></a><span class="lineno"> 1461</span><span class="comment">   * Null if no `async_receive_*()` is currently pending; else describes the arguments to that pending</span></div>
<div class="line"><a id="l01462" name="l01462"></a><span class="lineno"> 1462</span><span class="comment">   * `async_receive_*()`.</span></div>
<div class="line"><a id="l01463" name="l01463"></a><span class="lineno"> 1463</span><span class="comment">   *</span></div>
<div class="line"><a id="l01464" name="l01464"></a><span class="lineno"> 1464</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01465" name="l01465"></a><span class="lineno"> 1465</span><span class="comment">   *</span></div>
<div class="line"><a id="l01466" name="l01466"></a><span class="lineno"> 1466</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l01467" name="l01467"></a><span class="lineno"> 1467</span><span class="comment">   * It exists for a hopefully obvious reasons: At least a non-immediately-completed `async_receive_*()` needs</span></div>
<div class="line"><a id="l01468" name="l01468"></a><span class="lineno"> 1468</span><span class="comment">   * to keep track of the request so as to know where to place results and what completion handler to invoke.</span></div>
<div class="line"><a id="l01469" name="l01469"></a><span class="lineno"> 1469</span><span class="comment">   *</span></div>
<div class="line"><a id="l01470" name="l01470"></a><span class="lineno"> 1470</span><span class="comment">   * As for it being nullable: this is used to guard against `async_receive_*()` being invoked while another</span></div>
<div class="line"><a id="l01471" name="l01471"></a><span class="lineno"> 1471</span><span class="comment">   * is already outstanding.  We do not queue pending requests per</span></div>
<div class="line"><a id="l01472" name="l01472"></a><span class="lineno"> 1472</span><span class="comment">   * sync_io::Blob_receiver / sync_io::Native_handle_receiver concept.  (However the non-`sync_io` a/k/a async-I/O</span></div>
<div class="line"><a id="l01473" name="l01473"></a><span class="lineno"> 1473</span><span class="comment">   * Blob_receiver + Native_handle_receiver transport::Native_socket_stream does.  Therefore</span></div>
<div class="line"><a id="l01474" name="l01474"></a><span class="lineno"> 1474</span><span class="comment">   * the latter class does internally implement a `User_request` queue.  Rather sync_io::Async_adapter_receiver</span></div>
<div class="line"><a id="l01475" name="l01475"></a><span class="lineno"> 1475</span><span class="comment">   * does.)</span></div>
<div class="line"><a id="l01476" name="l01476"></a><span class="lineno"> 1476</span><span class="comment">   */</span></div>
<div class="line"><a id="l01477" name="l01477"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9098de978da64572c419019597274d68"> 1477</a></span>  std::optional&lt;Rcv_user_request&gt; <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9098de978da64572c419019597274d68">m_rcv_user_request</a>;</div>
<div class="line"><a id="l01478" name="l01478"></a><span class="lineno"> 1478</span><span class="comment"></span> </div>
<div class="line"><a id="l01479" name="l01479"></a><span class="lineno"> 1479</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01480" name="l01480"></a><span class="lineno"> 1480</span><span class="comment">   * Direct-write target, storing the length in bytes of the next meta-blob; 0 meaning the</span></div>
<div class="line"><a id="l01481" name="l01481"></a><span class="lineno"> 1481</span><span class="comment">   * current user message contains no meta-blob but only a native handle (or represents graceful-close if that</span></div>
<div class="line"><a id="l01482" name="l01482"></a><span class="lineno"> 1482</span><span class="comment">   * is also not present); and 0xFF... (#S_META_BLOB_LENGTH_PING_SENTINEL) meaning it&#39;s a mere ping.</span></div>
<div class="line"><a id="l01483" name="l01483"></a><span class="lineno"> 1483</span><span class="comment">   *</span></div>
<div class="line"><a id="l01484" name="l01484"></a><span class="lineno"> 1484</span><span class="comment">   * This plus a `Native_handle` is payload 1 received for each message; if, after successful read,</span></div>
<div class="line"><a id="l01485" name="l01485"></a><span class="lineno"> 1485</span><span class="comment">   * this is neither 0 nor #S_META_BLOB_LENGTH_PING_SENTINEL, then payload 2 -- the non-zero-sized</span></div>
<div class="line"><a id="l01486" name="l01486"></a><span class="lineno"> 1486</span><span class="comment">   * meta-blob -- is also read directly into the location specified by `m_rcv_user_request-&gt;m_target_meta_blob`.</span></div>
<div class="line"><a id="l01487" name="l01487"></a><span class="lineno"> 1487</span><span class="comment">   *</span></div>
<div class="line"><a id="l01488" name="l01488"></a><span class="lineno"> 1488</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01489" name="l01489"></a><span class="lineno"> 1489</span><span class="comment">   */</span></div>
<div class="line"><a id="l01490" name="l01490"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6676379057415274d2c6f2f096828cf9"> 1490</a></span>  <a class="code hl_typedef" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a881c376f1ee37f9b1a20f770824f55d9">low_lvl_payload_blob_length_t</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6676379057415274d2c6f2f096828cf9">m_rcv_target_meta_length</a>;</div>
<div class="line"><a id="l01491" name="l01491"></a><span class="lineno"> 1491</span><span class="comment"></span> </div>
<div class="line"><a id="l01492" name="l01492"></a><span class="lineno"> 1492</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01493" name="l01493"></a><span class="lineno"> 1493</span><span class="comment">   * The first and only connection-hosing error condition detected when attempting to low-level-read on</span></div>
<div class="line"><a id="l01494" name="l01494"></a><span class="lineno"> 1494</span><span class="comment">   * #m_peer_socket; or falsy if no such error has yet been detected.  Among possible other uses, it is emitted</span></div>
<div class="line"><a id="l01495" name="l01495"></a><span class="lineno"> 1495</span><span class="comment">   * to the ongoing-at-the-time `async_receive_*()`&#39;s completion handler (if one is indeed outstanding)</span></div>
<div class="line"><a id="l01496" name="l01496"></a><span class="lineno"> 1496</span><span class="comment">   * and immediately to any subsequent `async_receive_*()`.</span></div>
<div class="line"><a id="l01497" name="l01497"></a><span class="lineno"> 1497</span><span class="comment">   *</span></div>
<div class="line"><a id="l01498" name="l01498"></a><span class="lineno"> 1498</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01499" name="l01499"></a><span class="lineno"> 1499</span><span class="comment">   */</span></div>
<div class="line"><a id="l01500" name="l01500"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab824da16816893b2ffe2e778a7169b62"> 1500</a></span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab824da16816893b2ffe2e778a7169b62">m_rcv_pending_err_code</a>;</div>
<div class="line"><a id="l01501" name="l01501"></a><span class="lineno"> 1501</span><span class="comment"></span> </div>
<div class="line"><a id="l01502" name="l01502"></a><span class="lineno"> 1502</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01503" name="l01503"></a><span class="lineno"> 1503</span><span class="comment">   * `timeout` from idle_timer_run() args; or `zero()` if not yet called.  #m_rcv_idle_timer stays inactive</span></div>
<div class="line"><a id="l01504" name="l01504"></a><span class="lineno"> 1504</span><span class="comment">   * until this becomes not-`zero()`.</span></div>
<div class="line"><a id="l01505" name="l01505"></a><span class="lineno"> 1505</span><span class="comment">   *</span></div>
<div class="line"><a id="l01506" name="l01506"></a><span class="lineno"> 1506</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01507" name="l01507"></a><span class="lineno"> 1507</span><span class="comment">   */</span></div>
<div class="line"><a id="l01508" name="l01508"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ada7f2368dc0591f7a903946201c83636"> 1508</a></span>  <a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ada7f2368dc0591f7a903946201c83636">m_rcv_idle_timeout</a>;</div>
<div class="line"><a id="l01509" name="l01509"></a><span class="lineno"> 1509</span><span class="comment"></span> </div>
<div class="line"><a id="l01510" name="l01510"></a><span class="lineno"> 1510</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01511" name="l01511"></a><span class="lineno"> 1511</span><span class="comment">   * Timer that fires rcv_on_ev_idle_timer_fired() (which hoses the in-pipe with idle timeour error) and is</span></div>
<div class="line"><a id="l01512" name="l01512"></a><span class="lineno"> 1512</span><span class="comment">   * (re)scheduled to fire in #m_rcv_idle_timeout each time `*this` receives a complete message</span></div>
<div class="line"><a id="l01513" name="l01513"></a><span class="lineno"> 1513</span><span class="comment">   * on #m_peer_socket.  If it does fire, without being preempted by some error to have occurred since then,</span></div>
<div class="line"><a id="l01514" name="l01514"></a><span class="lineno"> 1514</span><span class="comment">   * the in-pipe is hosed with a particular error indicating idle-timeout (so that `Error_code` is saved</span></div>
<div class="line"><a id="l01515" name="l01515"></a><span class="lineno"> 1515</span><span class="comment">   * to #m_rcv_pending_err_code), while the out-pipe continues (#m_peer_socket lives).</span></div>
<div class="line"><a id="l01516" name="l01516"></a><span class="lineno"> 1516</span><span class="comment">   *</span></div>
<div class="line"><a id="l01517" name="l01517"></a><span class="lineno"> 1517</span><span class="comment">   * Since we implement `sync_io` pattern, the timer is obtained from, and used via, util::sync_io::Timer_event_emitter</span></div>
<div class="line"><a id="l01518" name="l01518"></a><span class="lineno"> 1518</span><span class="comment">   * #m_timer_worker.  See that member&#39;s doc header for more info.</span></div>
<div class="line"><a id="l01519" name="l01519"></a><span class="lineno"> 1519</span><span class="comment">   *</span></div>
<div class="line"><a id="l01520" name="l01520"></a><span class="lineno"> 1520</span><span class="comment">   * Relevant only once terminal State::S_PEER is reached.</span></div>
<div class="line"><a id="l01521" name="l01521"></a><span class="lineno"> 1521</span><span class="comment">   */</span></div>
<div class="line"><a id="l01522" name="l01522"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab65c4574a9a084030a9a66a8340c94b2"> 1522</a></span>  flow::util::Timer <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab65c4574a9a084030a9a66a8340c94b2">m_rcv_idle_timer</a>;</div>
<div class="line"><a id="l01523" name="l01523"></a><span class="lineno"> 1523</span><span class="comment"></span> </div>
<div class="line"><a id="l01524" name="l01524"></a><span class="lineno"> 1524</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01525" name="l01525"></a><span class="lineno"> 1525</span><span class="comment">   * Read-end of IPC-mechanism used by #m_timer_worker to ferry timer-fired events from #m_rcv_idle_timer</span></div>
<div class="line"><a id="l01526" name="l01526"></a><span class="lineno"> 1526</span><span class="comment">   * to `sync_io` outside async-wait to our actual on-timer-fired handler logic.</span></div>
<div class="line"><a id="l01527" name="l01527"></a><span class="lineno"> 1527</span><span class="comment">   *</span></div>
<div class="line"><a id="l01528" name="l01528"></a><span class="lineno"> 1528</span><span class="comment">   * @see #m_timer_worker for more info.</span></div>
<div class="line"><a id="l01529" name="l01529"></a><span class="lineno"> 1529</span><span class="comment">   */</span></div>
<div class="line"><a id="l01530" name="l01530"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa94400dd47704098beffe37b07b75472"> 1530</a></span>  <a class="code hl_typedef" href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">util::sync_io::Timer_event_emitter::Timer_fired_read_end</a>* <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa94400dd47704098beffe37b07b75472">m_rcv_idle_timer_fired_peer</a>;</div>
<div class="line"><a id="l01531" name="l01531"></a><span class="lineno"> 1531</span><span class="comment"></span> </div>
<div class="line"><a id="l01532" name="l01532"></a><span class="lineno"> 1532</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01533" name="l01533"></a><span class="lineno"> 1533</span><span class="comment">   * Descriptor waitable by outside event loop async-waits -- storing the same `Native_handle` as (and thus being</span></div>
<div class="line"><a id="l01534" name="l01534"></a><span class="lineno"> 1534</span><span class="comment">   * used to wait on events from) #m_rcv_idle_timer_fired_peer.</span></div>
<div class="line"><a id="l01535" name="l01535"></a><span class="lineno"> 1535</span><span class="comment">   *</span></div>
<div class="line"><a id="l01536" name="l01536"></a><span class="lineno"> 1536</span><span class="comment">   * @see #m_timer_worker for more info.</span></div>
<div class="line"><a id="l01537" name="l01537"></a><span class="lineno"> 1537</span><span class="comment">   */</span></div>
<div class="line"><a id="l01538" name="l01538"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3540ba657d9d7c95e755d1b348c88b8f"> 1538</a></span>  <a class="code hl_class" href="classipc_1_1util_1_1sync__io_1_1Asio__waitable__native__handle.html">util::sync_io::Asio_waitable_native_handle</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3540ba657d9d7c95e755d1b348c88b8f">m_rcv_ev_wait_hndl_idle_timer_fired_peer</a>;</div>
<div class="line"><a id="l01539" name="l01539"></a><span class="lineno"> 1539</span><span class="comment"></span> </div>
<div class="line"><a id="l01540" name="l01540"></a><span class="lineno"> 1540</span><span class="comment">  /**</span></div>
<div class="line"><a id="l01541" name="l01541"></a><span class="lineno"> 1541</span><span class="comment">   * Function (set forever in `start_receive_*_ops()`) through which we invoke the</span></div>
<div class="line"><a id="l01542" name="l01542"></a><span class="lineno"> 1542</span><span class="comment">   * outside event loop&#39;s async-wait facility for descriptors/events relevant to receive-ops.</span></div>
<div class="line"><a id="l01543" name="l01543"></a><span class="lineno"> 1543</span><span class="comment">   * See util::sync_io::Event_wait_func doc header for a refresher on this mechanic.</span></div>
<div class="line"><a id="l01544" name="l01544"></a><span class="lineno"> 1544</span><span class="comment">   */</span></div>
<div class="line"><a id="l01545" name="l01545"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5e1051f460cddb73d3cbc48afbac18a9"> 1545</a></span>  <a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a> <a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5e1051f460cddb73d3cbc48afbac18a9">m_rcv_ev_wait_func</a>;</div>
<div class="line"><a id="l01546" name="l01546"></a><span class="lineno"> 1546</span>}; <span class="comment">// class Native_socket_stream::Impl</span></div>
<div class="line"><a id="l01547" name="l01547"></a><span class="lineno"> 1547</span> </div>
<div class="line"><a id="l01548" name="l01548"></a><span class="lineno"> 1548</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l01549" name="l01549"></a><span class="lineno"> 1549</span> </div>
<div class="line"><a id="l01550" name="l01550"></a><span class="lineno"> 1550</span><span class="keyword">template</span>&lt;Native_socket_stream::Impl::Op OP&gt;</div>
<div class="line"><a id="l01551" name="l01551"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6c55ac2f7dad90d23bbd878e753ff791"> 1551</a></span><a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>* <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1ea07348e9e1cd7ff6c8dbdca290d9">Native_socket_stream::Impl::sync_io_ev_wait_func</a>()</div>
<div class="line"><a id="l01552" name="l01552"></a><span class="lineno"> 1552</span>{</div>
<div class="line"><a id="l01553" name="l01553"></a><span class="lineno"> 1553</span>  <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(OP == Op::S_SND)</div>
<div class="line"><a id="l01554" name="l01554"></a><span class="lineno"> 1554</span>  {</div>
<div class="line"><a id="l01555" name="l01555"></a><span class="lineno"> 1555</span>    <span class="keywordflow">return</span> &amp;<a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abd4d8d43776c3956c6896ca721e95dab">m_snd_ev_wait_func</a>;</div>
<div class="line"><a id="l01556" name="l01556"></a><span class="lineno"> 1556</span>  }</div>
<div class="line"><a id="l01557" name="l01557"></a><span class="lineno"> 1557</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(OP == Op::S_RCV)</div>
<div class="line"><a id="l01558" name="l01558"></a><span class="lineno"> 1558</span>  {</div>
<div class="line"><a id="l01559" name="l01559"></a><span class="lineno"> 1559</span>    <span class="keywordflow">return</span> &amp;<a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5e1051f460cddb73d3cbc48afbac18a9">m_rcv_ev_wait_func</a>;</div>
<div class="line"><a id="l01560" name="l01560"></a><span class="lineno"> 1560</span>  }</div>
<div class="line"><a id="l01561" name="l01561"></a><span class="lineno"> 1561</span>  <span class="keywordflow">else</span></div>
<div class="line"><a id="l01562" name="l01562"></a><span class="lineno"> 1562</span>  {</div>
<div class="line"><a id="l01563" name="l01563"></a><span class="lineno"> 1563</span>    <span class="keyword">static_assert</span>(OP == Op::S_CONN, <span class="stringliteral">&quot;What the....&quot;</span>);</div>
<div class="line"><a id="l01564" name="l01564"></a><span class="lineno"> 1564</span>    <span class="keywordflow">return</span> &amp;<a class="code hl_variable" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa020c49ecb9fb12fb554342f096b9822">m_conn_ev_wait_func</a>;</div>
<div class="line"><a id="l01565" name="l01565"></a><span class="lineno"> 1565</span>  }</div>
<div class="line"><a id="l01566" name="l01566"></a><span class="lineno"> 1566</span>} <span class="comment">// Native_socket_stream::Impl::sync_io_ev_wait_func()</span></div>
<div class="line"><a id="l01567" name="l01567"></a><span class="lineno"> 1567</span> </div>
<div class="line"><a id="l01568" name="l01568"></a><span class="lineno"> 1568</span><span class="keyword">template</span>&lt;Native_socket_stream::Impl::Op OP&gt;</div>
<div class="line"><a id="l01569" name="l01569"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1ea07348e9e1cd7ff6c8dbdca290d9"> 1569</a></span><span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>* <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1ea07348e9e1cd7ff6c8dbdca290d9">Native_socket_stream::Impl::sync_io_ev_wait_func</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l01570" name="l01570"></a><span class="lineno"> 1570</span><span class="keyword"></span>{</div>
<div class="line"><a id="l01571" name="l01571"></a><span class="lineno"> 1571</span>  <span class="keywordflow">return</span> <span class="keyword">const_cast&lt;</span><a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html">Impl</a>*<span class="keyword">&gt;</span>(<span class="keyword">this</span>)-&gt;sync_io_ev_wait_func&lt;OP&gt;();</div>
<div class="line"><a id="l01572" name="l01572"></a><span class="lineno"> 1572</span>}</div>
<div class="line"><a id="l01573" name="l01573"></a><span class="lineno"> 1573</span> </div>
<div class="line"><a id="l01574" name="l01574"></a><span class="lineno"> 1574</span><span class="keyword">template</span>&lt;Native_socket_stream::Impl::Op OP&gt;</div>
<div class="line"><a id="l01575" name="l01575"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7457705b8f6e8fc6c73dd758e593c7a9"> 1575</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7457705b8f6e8fc6c73dd758e593c7a9">Native_socket_stream::Impl::op_started</a>(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">util::String_view</a> context)<span class="keyword"> const</span></div>
<div class="line"><a id="l01576" name="l01576"></a><span class="lineno"> 1576</span><span class="keyword"></span>{</div>
<div class="line"><a id="l01577" name="l01577"></a><span class="lineno"> 1577</span>  <span class="keywordflow">if</span> (sync_io_ev_wait_func&lt;OP&gt;()-&gt;empty())</div>
<div class="line"><a id="l01578" name="l01578"></a><span class="lineno"> 1578</span>  {</div>
<div class="line"><a id="l01579" name="l01579"></a><span class="lineno"> 1579</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Socket stream [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Op-type [&quot;</span> &lt;&lt; <span class="keywordtype">int</span>(OP) &lt;&lt; <span class="stringliteral">&quot;]: &quot;</span></div>
<div class="line"><a id="l01580" name="l01580"></a><span class="lineno"> 1580</span>                     <span class="stringliteral">&quot;In context [&quot;</span> &lt;&lt; context &lt;&lt; <span class="stringliteral">&quot;] we must be start_...()ed, &quot;</span></div>
<div class="line"><a id="l01581" name="l01581"></a><span class="lineno"> 1581</span>                     <span class="stringliteral">&quot;but we are not.  Probably a caller bug, but it is not for us to judge.&quot;</span>);</div>
<div class="line"><a id="l01582" name="l01582"></a><span class="lineno"> 1582</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l01583" name="l01583"></a><span class="lineno"> 1583</span>  }</div>
<div class="line"><a id="l01584" name="l01584"></a><span class="lineno"> 1584</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l01585" name="l01585"></a><span class="lineno"> 1585</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l01586" name="l01586"></a><span class="lineno"> 1586</span>}</div>
<div class="line"><a id="l01587" name="l01587"></a><span class="lineno"> 1587</span> </div>
<div class="line"><a id="l01588" name="l01588"></a><span class="lineno"> 1588</span><span class="keyword">template</span>&lt;Native_socket_stream::Impl::Op OP&gt;</div>
<div class="line"><a id="l01589" name="l01589"></a><span class="lineno"><a class="line" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7065a2f2c759cc9e66d46c613e628a96"> 1589</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7065a2f2c759cc9e66d46c613e628a96">Native_socket_stream::Impl::start_ops</a>(<a class="code hl_typedef" href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">util::sync_io::Event_wait_func</a>&amp;&amp; ev_wait_func)</div>
<div class="line"><a id="l01590" name="l01590"></a><span class="lineno"> 1590</span>{</div>
<div class="line"><a id="l01591" name="l01591"></a><span class="lineno"> 1591</span>  <span class="keyword">const</span> <span class="keyword">auto</span> ev_wait_func_ptr = sync_io_ev_wait_func&lt;OP&gt;();</div>
<div class="line"><a id="l01592" name="l01592"></a><span class="lineno"> 1592</span> </div>
<div class="line"><a id="l01593" name="l01593"></a><span class="lineno"> 1593</span>  <span class="keywordflow">if</span> (!ev_wait_func_ptr-&gt;empty())</div>
<div class="line"><a id="l01594" name="l01594"></a><span class="lineno"> 1594</span>  {</div>
<div class="line"><a id="l01595" name="l01595"></a><span class="lineno"> 1595</span>    FLOW_LOG_WARNING(<span class="stringliteral">&quot;Socket stream [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Op-type [&quot;</span> &lt;&lt; <span class="keywordtype">int</span>(OP) &lt;&lt; <span class="stringliteral">&quot;]: Start-ops requested, &quot;</span></div>
<div class="line"><a id="l01596" name="l01596"></a><span class="lineno"> 1596</span>                     <span class="stringliteral">&quot;but we are already started.  Probably a caller bug, but it is not for us to judge.&quot;</span>);</div>
<div class="line"><a id="l01597" name="l01597"></a><span class="lineno"> 1597</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l01598" name="l01598"></a><span class="lineno"> 1598</span>  }</div>
<div class="line"><a id="l01599" name="l01599"></a><span class="lineno"> 1599</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l01600" name="l01600"></a><span class="lineno"> 1600</span> </div>
<div class="line"><a id="l01601" name="l01601"></a><span class="lineno"> 1601</span>  <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(OP == Op::S_CONN)</div>
<div class="line"><a id="l01602" name="l01602"></a><span class="lineno"> 1602</span>  {</div>
<div class="line"><a id="l01603" name="l01603"></a><span class="lineno"> 1603</span>    <span class="keywordflow">if</span> (m_state == State::S_PEER)</div>
<div class="line"><a id="l01604" name="l01604"></a><span class="lineno"> 1604</span>    {</div>
<div class="line"><a id="l01605" name="l01605"></a><span class="lineno"> 1605</span>      FLOW_LOG_WARNING(<span class="stringliteral">&quot;Socket stream [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Start-connect-ops requested, but we are already (and &quot;</span></div>
<div class="line"><a id="l01606" name="l01606"></a><span class="lineno"> 1606</span>                       <span class="stringliteral">&quot;irreversibly) in PEER state.  Probably a caller bug, but it is not for us to judge.&quot;</span>);</div>
<div class="line"><a id="l01607" name="l01607"></a><span class="lineno"> 1607</span>      <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l01608" name="l01608"></a><span class="lineno"> 1608</span>    }</div>
<div class="line"><a id="l01609" name="l01609"></a><span class="lineno"> 1609</span> </div>
<div class="line"><a id="l01610" name="l01610"></a><span class="lineno"> 1610</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l01611" name="l01611"></a><span class="lineno"> 1611</span>    assert((m_state == State::S_NULL)</div>
<div class="line"><a id="l01612" name="l01612"></a><span class="lineno"> 1612</span>           &amp;&amp; <span class="stringliteral">&quot;Should not be able to get to CONNECTING state without start_connect_ops() in the first place.&quot;</span>);</div>
<div class="line"><a id="l01613" name="l01613"></a><span class="lineno"> 1613</span>  }</div>
<div class="line"><a id="l01614" name="l01614"></a><span class="lineno"> 1614</span> </div>
<div class="line"><a id="l01615" name="l01615"></a><span class="lineno"> 1615</span>  *ev_wait_func_ptr = std::move(ev_wait_func);</div>
<div class="line"><a id="l01616" name="l01616"></a><span class="lineno"> 1616</span> </div>
<div class="line"><a id="l01617" name="l01617"></a><span class="lineno"> 1617</span>  FLOW_LOG_INFO(<span class="stringliteral">&quot;Socket stream [&quot;</span> &lt;&lt; *<span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;]: Op-type [&quot;</span> &lt;&lt; <span class="keywordtype">int</span>(OP) &lt;&lt; <span class="stringliteral">&quot;]: Start-ops requested.  Done.&quot;</span>);</div>
<div class="line"><a id="l01618" name="l01618"></a><span class="lineno"> 1618</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l01619" name="l01619"></a><span class="lineno"> 1619</span>} <span class="comment">// Native_socket_stream::Impl::start_ops()</span></div>
<div class="line"><a id="l01620" name="l01620"></a><span class="lineno"> 1620</span> </div>
<div class="line"><a id="l01621" name="l01621"></a><span class="lineno"> 1621</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l01622" name="l01622"></a><span class="lineno"> 1622</span><span class="comment"></span> </div>
<div class="line"><a id="l01623" name="l01623"></a><span class="lineno"> 1623</span><span class="comment">/**</span></div>
<div class="line"><a id="l01624" name="l01624"></a><span class="lineno"> 1624</span><span class="comment"> * Prints string representation of the given Native_socket_stream::Impl to the given `ostream`.</span></div>
<div class="line"><a id="l01625" name="l01625"></a><span class="lineno"> 1625</span><span class="comment"> *</span></div>
<div class="line"><a id="l01626" name="l01626"></a><span class="lineno"> 1626</span><span class="comment"> * @relatesalso Native_socket_stream::Impl</span></div>
<div class="line"><a id="l01627" name="l01627"></a><span class="lineno"> 1627</span><span class="comment"> *</span></div>
<div class="line"><a id="l01628" name="l01628"></a><span class="lineno"> 1628</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l01629" name="l01629"></a><span class="lineno"> 1629</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l01630" name="l01630"></a><span class="lineno"> 1630</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l01631" name="l01631"></a><span class="lineno"> 1631</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l01632" name="l01632"></a><span class="lineno"> 1632</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l01633" name="l01633"></a><span class="lineno"> 1633</span><span class="comment"> */</span></div>
<div class="line"><a id="l01634" name="l01634"></a><span class="lineno"> 1634</span>std::ostream&amp; <a class="code hl_friend" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html#ac6108711cc8b33c3b7ef0491ba78e2f6">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html">Native_socket_stream::Impl</a>&amp; val);</div>
<div class="line"><a id="l01635" name="l01635"></a><span class="lineno"> 1635</span> </div>
<div class="line"><a id="l01636" name="l01636"></a><span class="lineno"> 1636</span>} <span class="comment">// namespace ipc::transport::sync_io</span></div>
<div class="ttc" id="aasio__local__stream__socket_8hpp_html"><div class="ttname"><a href="asio__local__stream__socket_8hpp.html">asio_local_stream_socket.hpp</a></div></div>
<div class="ttc" id="aasio__local__stream__socket__fwd_8hpp_html"><div class="ttname"><a href="asio__local__stream__socket__fwd_8hpp.html">asio_local_stream_socket_fwd.hpp</a></div></div>
<div class="ttc" id="aasio__waitable__native__hndl_8hpp_html"><div class="ttname"><a href="asio__waitable__native__hndl_8hpp.html">asio_waitable_native_hndl.hpp</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Protocol__negotiator_html"><div class="ttname"><a href="classipc_1_1transport_1_1Protocol__negotiator.html">ipc::transport::Protocol_negotiator</a></div><div class="ttdoc">A simple state machine that, assuming the opposide side of a comm pathway uses an equivalent state ma...</div><div class="ttdef"><b>Definition:</b> <a href="protocol__negotiator_8hpp_source.html#l00189">protocol_negotiator.hpp:191</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html">ipc::transport::sync_io::Native_socket_stream::Impl</a></div><div class="ttdoc">Internal, non-movable pImpl implementation of sync_io::Native_socket_stream class.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00314">native_socket_stream_impl.hpp:317</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0257a7903bff120aa1523f8de04bccf7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0257a7903bff120aa1523f8de04bccf7">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_pending_err_code</a></div><div class="ttdeci">Error_code m_snd_pending_err_code</div><div class="ttdoc">The first and only connection-hosing error condition detected when attempting to low-level-write on m...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01392">native_socket_stream_impl.hpp:1392</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0900c54fc01d0d67b94208b47fff7469"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0900c54fc01d0d67b94208b47fff7469">ipc::transport::sync_io::Native_socket_stream::Impl::m_ev_hndl_task_engine_unused</a></div><div class="ttdeci">flow::util::Task_engine m_ev_hndl_task_engine_unused</div><div class="ttdoc">The Task_engine for m_*ev_wait_hndl_*, unless it is replaced via replace_event_wait_handles().</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01196">native_socket_stream_impl.hpp:1196</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0ac6a82eda9256cba45f3b5365d79355"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ac6a82eda9256cba45f3b5365d79355">ipc::transport::sync_io::Native_socket_stream::Impl::m_ev_wait_hndl_peer_socket</a></div><div class="ttdeci">util::sync_io::Asio_waitable_native_handle m_ev_wait_hndl_peer_socket</div><div class="ttdoc">Descriptor waitable by outside event loop async-waits – storing the same Native_handle as (and thus b...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01311">native_socket_stream_impl.hpp:1311</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0aca995c7150e72219b422c188d9bc23"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0aca995c7150e72219b422c188d9bc23">ipc::transport::sync_io::Native_socket_stream::Impl::async_end_sending</a></div><div class="ttdeci">bool async_end_sending(Error_code *sync_err_code, flow::async::Task_asio_err &amp;&amp;on_done_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00277">native_socket_stream_impl_snd.cpp:277</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0ba676425c97ae496255a155f41943f8"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ba676425c97ae496255a155f41943f8">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_read_blob</a></div><div class="ttdeci">void rcv_read_blob(Rcv_msg_state msg_state, const util::Blob_mutable &amp;target_blob, Error_code *sync_err_code, size_t *sync_sz)</div><div class="ttdoc">A somewhat-general utility that continues read chain with the aim to complete the present in-message,...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00611">native_socket_stream_impl_rcv.cpp:611</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0ddd1b1e57bc61827d457e16e3db8600"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0ddd1b1e57bc61827d457e16e3db8600">ipc::transport::sync_io::Native_socket_stream::Impl::nickname</a></div><div class="ttdeci">const std::string &amp; nickname() const</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00502">native_socket_stream_impl.cpp:502</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a0e765fbfee2c76293b572b01c9be5680"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a0e765fbfee2c76293b572b01c9be5680">ipc::transport::sync_io::Native_socket_stream::Impl::Rcv_msg_state</a></div><div class="ttdeci">Rcv_msg_state</div><div class="ttdoc">Used to organize tje incoming-direction state machine tactically, this indicates what part of payload...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00650">native_socket_stream_impl.hpp:651</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a12e99a2479fbf08b2fa32a2f17ed1ca7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a12e99a2479fbf08b2fa32a2f17ed1ca7">ipc::transport::sync_io::Native_socket_stream::Impl::start_receive_blob_ops</a></div><div class="ttdeci">bool start_receive_blob_ops(util::sync_io::Event_wait_func &amp;&amp;ev_wait_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00032">native_socket_stream_impl_rcv.cpp:32</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a1374593e1cecd44ccb07d939f3673a35"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1374593e1cecd44ccb07d939f3673a35">ipc::transport::sync_io::Native_socket_stream::Impl::m_nickname</a></div><div class="ttdeci">std::string m_nickname</div><div class="ttdoc">See nickname().</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01120">native_socket_stream_impl.hpp:1120</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a18de125ad318ba69cee7d8cb8204ad12"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a18de125ad318ba69cee7d8cb8204ad12">ipc::transport::sync_io::Native_socket_stream::Impl::state_peer</a></div><div class="ttdeci">bool state_peer(util::String_view context) const</div><div class="ttdoc">Checks whether m_state has reached State::S_PEER; if so returns true; if not logs WARNING and returns...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00507">native_socket_stream_impl.cpp:507</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a1af9eb83b9afee25ba153a2ca066858d"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1af9eb83b9afee25ba153a2ca066858d">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_pending_payloads_q</a></div><div class="ttdeci">std::queue&lt; Snd_low_lvl_payload::Ptr &gt; m_snd_pending_payloads_q</div><div class="ttdoc">Queue storing (at head) the currently in-progress async write-op of a Snd_low_lvl_payload; followed b...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01383">native_socket_stream_impl.hpp:1383</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a1caa342f726a273deb64317cbec8b5ea"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1caa342f726a273deb64317cbec8b5ea">ipc::transport::sync_io::Native_socket_stream::Impl::m_nb_task_engine</a></div><div class="ttdeci">flow::util::Task_engine m_nb_task_engine</div><div class="ttdoc">The Task_engine for m_peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01182">native_socket_stream_impl.hpp:1182</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a25e051170a8eb568745f809bb186f980"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a25e051170a8eb568745f809bb186f980">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_nb_read_low_lvl_payload</a></div><div class="ttdeci">size_t rcv_nb_read_low_lvl_payload(Native_handle *target_payload_hndl_or_null, const util::Blob_mutable &amp;target_payload_blob, Error_code *err_code)</div><div class="ttdoc">Utility that synchronously, non-blockingly attempts to read over m_peer_socket into the target blob a...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00683">native_socket_stream_impl_rcv.cpp:683</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a2c2b11477fb5089af7608c45dec939c0"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a2c2b11477fb5089af7608c45dec939c0">ipc::transport::sync_io::Native_socket_stream::Impl::snd_on_ev_peer_socket_writable_or_error</a></div><div class="ttdeci">void snd_on_ev_peer_socket_writable_or_error()</div><div class="ttdoc">Completion handler, from outside event loop via sync_io pattern, for the async-wait initiated by snd_...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00900">native_socket_stream_impl_snd.cpp:900</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3116d5b66bf35bec158905bbde4f6854"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3116d5b66bf35bec158905bbde4f6854">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_auto_ping_timer_fired_peer</a></div><div class="ttdeci">util::sync_io::Timer_event_emitter::Timer_fired_read_end * m_snd_auto_ping_timer_fired_peer</div><div class="ttdoc">Read-end of IPC-mechanism used by m_timer_worker to ferry timer-fired events from m_snd_auto_ping_tim...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01441">native_socket_stream_impl.hpp:1441</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a311a0641a1da83530311e16845105c2c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a311a0641a1da83530311e16845105c2c">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_auto_ping_timer</a></div><div class="ttdeci">flow::util::Timer m_snd_auto_ping_timer</div><div class="ttdoc">Timer that fires snd_on_ev_auto_ping_now_timer_fired() (which sends an auto-ping) and is always sched...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01433">native_socket_stream_impl.hpp:1433</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3540ba657d9d7c95e755d1b348c88b8f"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3540ba657d9d7c95e755d1b348c88b8f">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_ev_wait_hndl_idle_timer_fired_peer</a></div><div class="ttdeci">util::sync_io::Asio_waitable_native_handle m_rcv_ev_wait_hndl_idle_timer_fired_peer</div><div class="ttdoc">Descriptor waitable by outside event loop async-waits – storing the same Native_handle as (and thus b...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01538">native_socket_stream_impl.hpp:1538</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a393316703a666a9b022f2b879337b920"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a393316703a666a9b022f2b879337b920">ipc::transport::sync_io::Native_socket_stream::Impl::m_protocol_negotiator</a></div><div class="ttdeci">Protocol_negotiator m_protocol_negotiator</div><div class="ttdoc">Handles the protocol negotiation at the start of the pipe.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01171">native_socket_stream_impl.hpp:1171</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3b6b76dfbddc562ece4f64742ff6d2c7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3b6b76dfbddc562ece4f64742ff6d2c7">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_on_head_payload</a></div><div class="ttdeci">void rcv_on_head_payload(Error_code *sync_err_code, size_t *sync_sz)</div><div class="ttdoc">Reacts to payload 1 having been completely received.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00440">native_socket_stream_impl_rcv.cpp:440</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3c1c949f345f0ceef5eeca3c2edec291"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1c949f345f0ceef5eeca3c2edec291">ipc::transport::sync_io::Native_socket_stream::Impl::snd_sync_write_or_q_payload</a></div><div class="ttdeci">bool snd_sync_write_or_q_payload(Native_handle hndl_or_null, const util::Blob_const &amp;orig_blob, bool avoid_qing)</div><div class="ttdoc">Either synchronously sends hndl_or_null handle (if any) and orig_blob low-level blob over m_peer_sock...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00606">native_socket_stream_impl_snd.cpp:606</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3c1ea07348e9e1cd7ff6c8dbdca290d9"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c1ea07348e9e1cd7ff6c8dbdca290d9">ipc::transport::sync_io::Native_socket_stream::Impl::sync_io_ev_wait_func</a></div><div class="ttdeci">const util::sync_io::Event_wait_func * sync_io_ev_wait_func() const</div><div class="ttdoc">For boiler-plate-reducing generic code: Returns the m_*_ev_wait_func corresponding to the given Op.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01569">native_socket_stream_impl.hpp:1569</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3c5187e34876a0419ff70734ec0fbf14"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c5187e34876a0419ff70734ec0fbf14">ipc::transport::sync_io::Native_socket_stream::Impl::sync_connect</a></div><div class="ttdeci">bool sync_connect(const Shared_name &amp;absolute_name, Error_code *err_code)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00186">native_socket_stream_impl.cpp:186</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a3c6214376ab8bc59823635d405f9704a"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a3c6214376ab8bc59823635d405f9704a">ipc::transport::sync_io::Native_socket_stream::Impl::start_connect_ops</a></div><div class="ttdeci">bool start_connect_ops(util::sync_io::Event_wait_func &amp;&amp;ev_wait_func)</div><div class="ttdoc">It is start_ops&lt;Op::S_CONN&gt;().</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00181">native_socket_stream_impl.cpp:181</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a42aab631e9c70bfaa53764309adfe37c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a42aab631e9c70bfaa53764309adfe37c">ipc::transport::sync_io::Native_socket_stream::Impl::m_peer_socket</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; asio_local_stream_socket::Peer_socket &gt; m_peer_socket</div><div class="ttdoc">The peer stream-type Unix domain socket; or null pointer if we've detected the connection has become ...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01296">native_socket_stream_impl.hpp:1296</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a459618a64d769ba8798a6380e9292181"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a459618a64d769ba8798a6380e9292181">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_ev_wait_hndl_auto_ping_timer_fired_peer</a></div><div class="ttdeci">util::sync_io::Asio_waitable_native_handle m_snd_ev_wait_hndl_auto_ping_timer_fired_peer</div><div class="ttdoc">Descriptor waitable by outside event loop async-waits – storing the same Native_handle as (and thus b...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01449">native_socket_stream_impl.hpp:1449</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a4a94088b9f00288ae7e2cf3c7b49c444"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4a94088b9f00288ae7e2cf3c7b49c444">ipc::transport::sync_io::Native_socket_stream::Impl::start_receive_native_handle_ops</a></div><div class="ttdeci">bool start_receive_native_handle_ops(util::sync_io::Event_wait_func &amp;&amp;ev_wait_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00027">native_socket_stream_impl_rcv.cpp:27</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a4b31da3a7ff63f307bd08e288c391556"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4b31da3a7ff63f307bd08e288c391556">ipc::transport::sync_io::Native_socket_stream::Impl::snd_on_ev_auto_ping_now_timer_fired</a></div><div class="ttdeci">void snd_on_ev_auto_ping_now_timer_fired()</div><div class="ttdoc">Handler for the async-wait, via util::sync_io::Timer_event_emitter, of the auto-ping timer firing; if...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00544">native_socket_stream_impl_snd.cpp:544</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a4c3d1ba7c70649898a7893daf076c7ae"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4c3d1ba7c70649898a7893daf076c7ae">ipc::transport::sync_io::Native_socket_stream::Impl::async_receive_blob</a></div><div class="ttdeci">bool async_receive_blob(const util::Blob_mutable &amp;target_blob, Error_code *sync_err_code, size_t *sync_sz, flow::async::Task_asio_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00054">native_socket_stream_impl_rcv.cpp:54</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a4cb5d8ce6fa402c2cbaf27ec9654277c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4cb5d8ce6fa402c2cbaf27ec9654277c">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_auto_ping_period</a></div><div class="ttdeci">util::Fine_duration m_snd_auto_ping_period</div><div class="ttdoc">Equals zero() before auto_ping(); immutably equals period (auto_ping() arg) subsequently to that firs...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01418">native_socket_stream_impl.hpp:1418</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a53b356e756923271fbb9b7a7beb8f54a"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a53b356e756923271fbb9b7a7beb8f54a">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_on_ev_idle_timer_fired</a></div><div class="ttdeci">void rcv_on_ev_idle_timer_fired()</div><div class="ttdoc">Handler for the async-wait, via util::sync_io::Timer_event_emitter, of the idle timer firing; if stil...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00210">native_socket_stream_impl_rcv.cpp:210</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a54c3fdde2cf99fda314ee3387f70a02e"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a54c3fdde2cf99fda314ee3387f70a02e">ipc::transport::sync_io::Native_socket_stream::Impl::m_timer_worker</a></div><div class="ttdeci">util::sync_io::Timer_event_emitter m_timer_worker</div><div class="ttdoc">As typical in timer-needing sync_io-pattern-implementing objects, maintains a thread exclusively for ...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01324">native_socket_stream_impl.hpp:1324</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a59e9935bdd704c40173a40e87b5db131"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a59e9935bdd704c40173a40e87b5db131">ipc::transport::sync_io::Native_socket_stream::Impl::send_native_handle</a></div><div class="ttdeci">bool send_native_handle(Native_handle hndl_or_null, const util::Blob_const &amp;meta_blob, Error_code *err_code)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00094">native_socket_stream_impl_snd.cpp:94</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a5e1051f460cddb73d3cbc48afbac18a9"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5e1051f460cddb73d3cbc48afbac18a9">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_ev_wait_func</a></div><div class="ttdeci">util::sync_io::Event_wait_func m_rcv_ev_wait_func</div><div class="ttdoc">Function (set forever in start_receive_*_ops()) through which we invoke the outside event loop's asyn...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01545">native_socket_stream_impl.hpp:1545</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a5e9ed53ef25f4413c8da315f8dbcff2c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5e9ed53ef25f4413c8da315f8dbcff2c">ipc::transport::sync_io::Native_socket_stream::Impl::snd_async_write_q_head_payload</a></div><div class="ttdeci">void snd_async_write_q_head_payload()</div><div class="ttdoc">Initiates async-write over m_peer_socket of the low-level payload at the head of out-queue m_snd_pend...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00846">native_socket_stream_impl_snd.cpp:846</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a5fe9845081e656642a8b9f82f82228f6"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a5fe9845081e656642a8b9f82f82228f6">ipc::transport::sync_io::Native_socket_stream::Impl::send_meta_blob_max_size</a></div><div class="ttdeci">size_t send_meta_blob_max_size() const</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l01016">native_socket_stream_impl_snd.cpp:1016</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a6337b0d5d703f124def66853e36b62e5"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6337b0d5d703f124def66853e36b62e5">ipc::transport::sync_io::Native_socket_stream::Impl::async_end_sending_impl</a></div><div class="ttdeci">bool async_end_sending_impl(Error_code *sync_err_code_ptr_or_null, flow::async::Task_asio_err &amp;&amp;on_done_func_or_empty)</div><div class="ttdoc">*end_sending() body.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00302">native_socket_stream_impl_snd.cpp:302</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a64e47a38b3ed59e37295336114918142"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a64e47a38b3ed59e37295336114918142">ipc::transport::sync_io::Native_socket_stream::Impl::m_state</a></div><div class="ttdeci">State m_state</div><div class="ttdoc">The current state of *this.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01145">native_socket_stream_impl.hpp:1145</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a65eea0cec146df598fce1d9ab5ce7e15"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a65eea0cec146df598fce1d9ab5ce7e15">ipc::transport::sync_io::Native_socket_stream::Impl::start_send_native_handle_ops</a></div><div class="ttdeci">bool start_send_native_handle_ops(util::sync_io::Event_wait_func &amp;&amp;ev_wait_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00028">native_socket_stream_impl_snd.cpp:28</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a6600090ca22c9b940155f7920b1465e4"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6600090ca22c9b940155f7920b1465e4">ipc::transport::sync_io::Native_socket_stream::Impl::remote_peer_process_credentials</a></div><div class="ttdeci">util::Process_credentials remote_peer_process_credentials(Error_code *err_code) const</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00473">native_socket_stream_impl.cpp:473</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a6676379057415274d2c6f2f096828cf9"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6676379057415274d2c6f2f096828cf9">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_target_meta_length</a></div><div class="ttdeci">low_lvl_payload_blob_length_t m_rcv_target_meta_length</div><div class="ttdoc">Direct-write target, storing the length in bytes of the next meta-blob; 0 meaning the current user me...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01490">native_socket_stream_impl.hpp:1490</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a6a01d2df2772ee72e4386e84684394e3"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a6a01d2df2772ee72e4386e84684394e3">ipc::transport::sync_io::Native_socket_stream::Impl::start_send_blob_ops</a></div><div class="ttdeci">bool start_send_blob_ops(util::sync_io::Event_wait_func &amp;&amp;ev_wait_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00083">native_socket_stream_impl_snd.cpp:83</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a7065a2f2c759cc9e66d46c613e628a96"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7065a2f2c759cc9e66d46c613e628a96">ipc::transport::sync_io::Native_socket_stream::Impl::start_ops</a></div><div class="ttdeci">bool start_ops(util::sync_io::Event_wait_func &amp;&amp;ev_wait_func)</div><div class="ttdoc">Boiler-plate-reducing body of start_*_ops() for the given Op.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01589">native_socket_stream_impl.hpp:1589</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a7457705b8f6e8fc6c73dd758e593c7a9"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7457705b8f6e8fc6c73dd758e593c7a9">ipc::transport::sync_io::Native_socket_stream::Impl::op_started</a></div><div class="ttdeci">bool op_started(util::String_view context) const</div><div class="ttdoc">Helper that returns true silently if the given Op start_*_ops() has been called; else logs WARNING an...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01575">native_socket_stream_impl.hpp:1575</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a7b825476c04ea53eccea862d34f830c6"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a7b825476c04ea53eccea862d34f830c6">ipc::transport::sync_io::Native_socket_stream::Impl::S_MAX_META_BLOB_LENGTH</a></div><div class="ttdeci">static const size_t S_MAX_META_BLOB_LENGTH</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00322">native_socket_stream_impl.hpp:322</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a881c376f1ee37f9b1a20f770824f55d9"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a881c376f1ee37f9b1a20f770824f55d9">ipc::transport::sync_io::Native_socket_stream::Impl::low_lvl_payload_blob_length_t</a></div><div class="ttdeci">uint16_t low_lvl_payload_blob_length_t</div><div class="ttdoc">The type used to encode the meta-blob length; this puts a cap on how long the meta-blobs can be.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00685">native_socket_stream_impl.hpp:685</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a8b9839bb39e95a51ed7c920137438a21"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a8b9839bb39e95a51ed7c920137438a21">ipc::transport::sync_io::Native_socket_stream::Impl::replace_event_wait_handles</a></div><div class="ttdeci">bool replace_event_wait_handles(const Function&lt; util::sync_io::Asio_waitable_native_handle()&gt; &amp;create_ev_wait_hndl_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00439">native_socket_stream_impl.cpp:440</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a9098de978da64572c419019597274d68"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9098de978da64572c419019597274d68">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_user_request</a></div><div class="ttdeci">std::optional&lt; Rcv_user_request &gt; m_rcv_user_request</div><div class="ttdoc">Null if no async_receive_*() is currently pending; else describes the arguments to that pending async...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01477">native_socket_stream_impl.hpp:1477</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a92372b2da3a4bdccda23b27b2865f01d"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a92372b2da3a4bdccda23b27b2865f01d">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_pending_on_last_send_done_func_or_empty</a></div><div class="ttdeci">flow::async::Task_asio_err m_snd_pending_on_last_send_done_func_or_empty</div><div class="ttdoc">Function passed to async_end_sending(), if it returned true and was unable to synchronously flush eve...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01410">native_socket_stream_impl.hpp:1410</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_a9c9825f74472868eb1397c33edf78fb4"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a9c9825f74472868eb1397c33edf78fb4">ipc::transport::sync_io::Native_socket_stream::Impl::State</a></div><div class="ttdeci">State</div><div class="ttdoc">Overall state of a Native_socket_stream::Impl.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00576">native_socket_stream_impl.hpp:577</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aa020c49ecb9fb12fb554342f096b9822"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa020c49ecb9fb12fb554342f096b9822">ipc::transport::sync_io::Native_socket_stream::Impl::m_conn_ev_wait_func</a></div><div class="ttdeci">util::sync_io::Event_wait_func m_conn_ev_wait_func</div><div class="ttdoc">Function (set forever in start_connect_ops()) through which we invoke the outside event loop's async-...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01372">native_socket_stream_impl.hpp:1372</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aa2d79438a470aa94feb2fbbcd72dc629"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa2d79438a470aa94feb2fbbcd72dc629">ipc::transport::sync_io::Native_socket_stream::Impl::m_conn_ev_wait_hndl_peer_socket</a></div><div class="ttdeci">std::optional&lt; util::sync_io::Asio_waitable_native_handle &gt; m_conn_ev_wait_hndl_peer_socket</div><div class="ttdoc">This is to (m_peer_socket, m_conn_async_worker) what m_ev_wait_hndl_peer_socket is to (m_peer_socket,...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01365">native_socket_stream_impl.hpp:1365</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aa342b6f0c7e2015517a5c465e4963fc7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa342b6f0c7e2015517a5c465e4963fc7">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_on_handle_finalized</a></div><div class="ttdeci">void rcv_on_handle_finalized(Native_handle hndl_or_null, size_t n_rcvd, Error_code *sync_err_code, size_t *sync_sz)</div><div class="ttdoc">Helper of rcv_read_msg() – it could have been inlined instead of a method but for readability concern...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00348">native_socket_stream_impl_rcv.cpp:348</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aa3b06f1d59f5635c81a99e4ae8f7b8c7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa3b06f1d59f5635c81a99e4ae8f7b8c7">ipc::transport::sync_io::Native_socket_stream::Impl::async_receive_native_handle</a></div><div class="ttdeci">bool async_receive_native_handle(Native_handle *target_hndl, const util::Blob_mutable &amp;target_meta_blob, Error_code *sync_err_code, size_t *sync_sz, flow::async::Task_asio_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00037">native_socket_stream_impl_rcv.cpp:37</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aa8c4ec6715dc5c437ed285cfea600b46"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa8c4ec6715dc5c437ed285cfea600b46">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_read_msg</a></div><div class="ttdeci">void rcv_read_msg(Error_code *sync_err_code, size_t *sync_sz)</div><div class="ttdoc">Begins read chain (completing it as synchronously as possible, async-completing the rest) for the nex...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00279">native_socket_stream_impl_rcv.cpp:279</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aa94400dd47704098beffe37b07b75472"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aa94400dd47704098beffe37b07b75472">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_idle_timer_fired_peer</a></div><div class="ttdeci">util::sync_io::Timer_event_emitter::Timer_fired_read_end * m_rcv_idle_timer_fired_peer</div><div class="ttdoc">Read-end of IPC-mechanism used by m_timer_worker to ferry timer-fired events from m_rcv_idle_timer to...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01530">native_socket_stream_impl.hpp:1530</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aaef639c110a0e3d6804da84f9458ae78"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aaef639c110a0e3d6804da84f9458ae78">ipc::transport::sync_io::Native_socket_stream::Impl::send_blob</a></div><div class="ttdeci">bool send_blob(const util::Blob_const &amp;blob, Error_code *err_code)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00088">native_socket_stream_impl_snd.cpp:88</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aaf965dc1eea3bee807c2fb6c4a937bb5"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aaf965dc1eea3bee807c2fb6c4a937bb5">ipc::transport::sync_io::Native_socket_stream::Impl::conn_on_ev_peer_socket_writable</a></div><div class="ttdeci">void conn_on_ev_peer_socket_writable(flow::async::Task_asio_err &amp;&amp;on_done_func)</div><div class="ttdoc">Handler for the async-wait in case async_connect() cannot synchronously complete the m_peer_socket co...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00420">native_socket_stream_impl.cpp:420</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ab65c4574a9a084030a9a66a8340c94b2"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab65c4574a9a084030a9a66a8340c94b2">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_idle_timer</a></div><div class="ttdeci">flow::util::Timer m_rcv_idle_timer</div><div class="ttdoc">Timer that fires rcv_on_ev_idle_timer_fired() (which hoses the in-pipe with idle timeour error) and i...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01522">native_socket_stream_impl.hpp:1522</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ab7b382067804495cbae180a5bc1a2757"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab7b382067804495cbae180a5bc1a2757">ipc::transport::sync_io::Native_socket_stream::Impl::auto_ping</a></div><div class="ttdeci">bool auto_ping(util::Fine_duration period)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00440">native_socket_stream_impl_snd.cpp:440</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ab824da16816893b2ffe2e778a7169b62"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ab824da16816893b2ffe2e778a7169b62">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_pending_err_code</a></div><div class="ttdeci">Error_code m_rcv_pending_err_code</div><div class="ttdoc">The first and only connection-hosing error condition detected when attempting to low-level-read on m_...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01500">native_socket_stream_impl.hpp:1500</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_abc7d2b14208ed2b8c0add0c26f7fbf27"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abc7d2b14208ed2b8c0add0c26f7fbf27">ipc::transport::sync_io::Native_socket_stream::Impl::m_peer_socket_mutex</a></div><div class="ttdeci">flow::util::Mutex_non_recursive m_peer_socket_mutex</div><div class="ttdoc">Protects m_peer_socket and its bro m_ev_wait_hndl_peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01314">native_socket_stream_impl.hpp:1314</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_abd4d8d43776c3956c6896ca721e95dab"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abd4d8d43776c3956c6896ca721e95dab">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_ev_wait_func</a></div><div class="ttdeci">util::sync_io::Event_wait_func m_snd_ev_wait_func</div><div class="ttdoc">Function (set forever in start_send_*_ops()) through which we invoke the outside event loop's async-w...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01456">native_socket_stream_impl.hpp:1456</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_abedd0db5a5ae04e47085728ae548d07c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#abedd0db5a5ae04e47085728ae548d07c">ipc::transport::sync_io::Native_socket_stream::Impl::idle_timer_run</a></div><div class="ttdeci">bool idle_timer_run(util::Fine_duration timeout)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00154">native_socket_stream_impl_rcv.cpp:154</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ac5471d1f4f7cad2aeb239b5f458f12f2"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ac5471d1f4f7cad2aeb239b5f458f12f2">ipc::transport::sync_io::Native_socket_stream::Impl::Op</a></div><div class="ttdeci">Op</div><div class="ttdoc">Compile-time tagging enumeration identifying the op-type of a given sync_io activity.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00674">native_socket_stream_impl.hpp:675</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ace12ebbb258f933e517255294f372795"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ace12ebbb258f933e517255294f372795">ipc::transport::sync_io::Native_socket_stream::Impl::receive_blob_max_size</a></div><div class="ttdeci">size_t receive_blob_max_size() const</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00802">native_socket_stream_impl_rcv.cpp:802</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_acfefc83c990b1b6cd903f5ad323e5dfa"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#acfefc83c990b1b6cd903f5ad323e5dfa">ipc::transport::sync_io::Native_socket_stream::Impl::m_snd_finished</a></div><div class="ttdeci">bool m_snd_finished</div><div class="ttdoc">false at start; set to true forever on the first *end_sending() invocation; true will prevent any sub...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01401">native_socket_stream_impl.hpp:1401</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ad5e487595e2a58f7ff25b4f4c91fe4bc"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ad5e487595e2a58f7ff25b4f4c91fe4bc">ipc::transport::sync_io::Native_socket_stream::Impl::S_META_BLOB_LENGTH_PING_SENTINEL</a></div><div class="ttdeci">static const low_lvl_payload_blob_length_t S_META_BLOB_LENGTH_PING_SENTINEL</div><div class="ttdoc">Value for the length field in payload 1 that means &quot;not a length; indicating this is a ping message....</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00697">native_socket_stream_impl.hpp:697</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ad6443fb49be059dbe76c75d86a18197e"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ad6443fb49be059dbe76c75d86a18197e">ipc::transport::sync_io::Native_socket_stream::Impl::async_connect</a></div><div class="ttdeci">void async_connect(const Shared_name &amp;absolute_name, Error_code *sync_err_code, flow::async::Task_asio_err &amp;&amp;on_done_func)</div><div class="ttdoc">The core of sync_connect(), written in the sync_io-pattern style.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00281">native_socket_stream_impl.cpp:281</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ada7f2368dc0591f7a903946201c83636"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ada7f2368dc0591f7a903946201c83636">ipc::transport::sync_io::Native_socket_stream::Impl::m_rcv_idle_timeout</a></div><div class="ttdeci">util::Fine_duration m_rcv_idle_timeout</div><div class="ttdoc">timeout from idle_timer_run() args; or zero() if not yet called.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01508">native_socket_stream_impl.hpp:1508</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_adeb067b178e7688dde0ca7c5eb877b1d"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#adeb067b178e7688dde0ca7c5eb877b1d">ipc::transport::sync_io::Native_socket_stream::Impl::~Impl</a></div><div class="ttdeci">~Impl()</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00174">native_socket_stream_impl.cpp:174</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_adff873e21beee6c31a552293d8b0004c"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#adff873e21beee6c31a552293d8b0004c">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_not_idle</a></div><div class="ttdeci">void rcv_not_idle()</div><div class="ttdoc">No-ops if idle_timer_run() is not engaged; otherwise reacts to non-idleness of the in-pipe by resched...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00244">native_socket_stream_impl_rcv.cpp:244</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ae094bf64dda8f6c6e013400a77fd1343"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae094bf64dda8f6c6e013400a77fd1343">ipc::transport::sync_io::Native_socket_stream::Impl::m_conn_async_worker</a></div><div class="ttdeci">std::optional&lt; flow::async::Single_thread_task_loop &gt; m_conn_async_worker</div><div class="ttdoc">Event loop used exclusively by sync_connect() which as needed -&gt;start()s a short-lived thread and -&gt;s...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l01335">native_socket_stream_impl.hpp:1335</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ae16d560bf3c4eccfa975d47af71cb145"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae16d560bf3c4eccfa975d47af71cb145">ipc::transport::sync_io::Native_socket_stream::Impl::async_receive_native_handle_impl</a></div><div class="ttdeci">bool async_receive_native_handle_impl(Native_handle *target_hndl_or_null, const util::Blob_mutable &amp;target_meta_blob, Error_code *sync_err_code, size_t *sync_sz, flow::async::Task_asio_err_sz &amp;&amp;on_done_func)</div><div class="ttdoc">Body of both async_receive_native_handle() and async_receive_blob().</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00061">native_socket_stream_impl_rcv.cpp:61</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_ae9194e2eefe81185d1bf067b1f934657"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#ae9194e2eefe81185d1bf067b1f934657">ipc::transport::sync_io::Native_socket_stream::Impl::Impl</a></div><div class="ttdeci">Impl(flow::log::Logger *logger_ptr, util::String_view nickname_str)</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8cpp_source.html#l00069">native_socket_stream_impl.cpp:69</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_aef7a604a32db50eaf5fc501e5a205dd3"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#aef7a604a32db50eaf5fc501e5a205dd3">ipc::transport::sync_io::Native_socket_stream::Impl::end_sending</a></div><div class="ttdeci">bool end_sending()</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00272">native_socket_stream_impl_snd.cpp:272</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_af321a9b3ed8dc21f23988bf79c7c33f0"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#af321a9b3ed8dc21f23988bf79c7c33f0">ipc::transport::sync_io::Native_socket_stream::Impl::snd_nb_write_low_lvl_payload</a></div><div class="ttdeci">size_t snd_nb_write_low_lvl_payload(Native_handle hndl_or_null, const util::Blob_const &amp;blob, Error_code *err_code)</div><div class="ttdoc">Utility that sends non-empty blob, and (unless null) hndl_or_null associated with its 1st byte,...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l00740">native_socket_stream_impl_snd.cpp:740</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_af324ad8945ab79d74e937e9c38c2fbb5"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#af324ad8945ab79d74e937e9c38c2fbb5">ipc::transport::sync_io::Native_socket_stream::Impl::rcv_on_ev_peer_socket_readable_or_error</a></div><div class="ttdeci">void rcv_on_ev_peer_socket_readable_or_error(Rcv_msg_state msg_state, size_t n_left)</div><div class="ttdoc">Completion handler, from outside event loop via sync_io pattern, for the async-wait initiated by vari...</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00542">native_socket_stream_impl_rcv.cpp:542</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_af5d6e9275386dfefddb7a97248b039a7"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#af5d6e9275386dfefddb7a97248b039a7">ipc::transport::sync_io::Native_socket_stream::Impl::receive_meta_blob_max_size</a></div><div class="ttdeci">size_t receive_meta_blob_max_size() const</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__rcv_8cpp_source.html#l00797">native_socket_stream_impl_rcv.cpp:797</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_html_afa6b6e1be0f00add0b53b3263c412c76"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#afa6b6e1be0f00add0b53b3263c412c76">ipc::transport::sync_io::Native_socket_stream::Impl::send_blob_max_size</a></div><div class="ttdeci">size_t send_blob_max_size() const</div><div class="ttdoc">See Native_socket_stream counterpart.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__impl__snd_8cpp_source.html#l01021">native_socket_stream_impl_snd.cpp:1021</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_html_ac6108711cc8b33c3b7ef0491ba78e2f6"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html#ac6108711cc8b33c3b7ef0491ba78e2f6">ipc::transport::sync_io::Native_socket_stream::operator&lt;&lt;</a></div><div class="ttdeci">friend std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Native_socket_stream &amp;val)</div><div class="ttdoc">Friend of Native_socket_stream.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__socket__stream_8cpp_source.html#l00155">native_socket_stream.cpp:155</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Process__credentials_html"><div class="ttname"><a href="classipc_1_1util_1_1Process__credentials.html">ipc::util::Process_credentials</a></div><div class="ttdoc">A process's credentials (PID, UID, GID as of this writing).</div><div class="ttdef"><b>Definition:</b> <a href="process__credentials_8hpp_source.html#l00038">process_credentials.hpp:39</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Asio__waitable__native__handle_html"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Asio__waitable__native__handle.html">ipc::util::sync_io::Asio_waitable_native_handle</a></div><div class="ttdoc">Useful if using the sync_io pattern within a user event loop built on boost.asio (optionally with flo...</div><div class="ttdef"><b>Definition:</b> <a href="asio__waitable__native__hndl_8hpp_source.html#l00080">asio_waitable_native_hndl.hpp:81</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html">ipc::util::sync_io::Timer_event_emitter</a></div><div class="ttdoc">An object of this type, used internally to implement sync_io-pattern objects that require timer event...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00145">timer_ev_emitter.hpp:148</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1sync__io_1_1Timer__event__emitter_html_a1533a54927a64579fda02c61ec94b735"><div class="ttname"><a href="classipc_1_1util_1_1sync__io_1_1Timer__event__emitter.html#a1533a54927a64579fda02c61ec94b735">ipc::util::sync_io::Timer_event_emitter::Timer_fired_read_end</a></div><div class="ttdeci">boost::asio::readable_pipe Timer_fired_read_end</div><div class="ttdoc">Object representing the read end of IPC mechanism, where readable status indicates the associated tim...</div><div class="ttdef"><b>Definition:</b> <a href="timer__ev__emitter_8hpp_source.html#l00162">timer_ev_emitter.hpp:162</a></div></div>
<div class="ttc" id="adetail_2transport__fwd_8hpp_html"><div class="ttname"><a href="detail_2transport__fwd_8hpp.html">transport_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1sync__io_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1sync__io.html">ipc::transport::sync_io</a></div><div class="ttdoc">sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::transport.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2transport__fwd_8hpp_source.html#l00069">transport_fwd.hpp:70</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_1_1sync__io_html_aa0b9a3cc6bdc7dedbef4f9e06851aa24"><div class="ttname"><a href="namespaceipc_1_1util_1_1sync__io.html#aa0b9a3cc6bdc7dedbef4f9e06851aa24">ipc::util::sync_io::Event_wait_func</a></div><div class="ttdeci">Function&lt; void(Asio_waitable_native_handle *hndl_of_interest, bool ev_of_interest_snd_else_rcv, Task_ptr &amp;&amp;on_active_ev_func)&gt; Event_wait_func</div><div class="ttdoc">In sync_io pattern, concrete type storing user-supplied function invoked by pattern-implementing ipc:...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io__fwd_8hpp_source.html#l00798">sync_io_fwd.hpp:800</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6cb62ae434900f3a8915b33ec5d61a96"><div class="ttname"><a href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">ipc::util::Blob_mutable</a></div><div class="ttdeci">boost::asio::mutable_buffer Blob_mutable</div><div class="ttdoc">Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00140">util_fwd.hpp:140</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ac66141280c3b7295a86b65209f31cc58"><div class="ttname"><a href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">ipc::util::Fine_duration</a></div><div class="ttdeci">flow::Fine_duration Fine_duration</div><div class="ttdoc">Short-hand for Flow's Fine_duration.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00117">util_fwd.hpp:117</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae6ac47812a90d1287c61e0b7de7bc4f5"><div class="ttname"><a href="namespaceipc_1_1util.html#ae6ac47812a90d1287c61e0b7de7bc4f5">ipc::util::String_view</a></div><div class="ttdeci">flow::util::String_view String_view</div><div class="ttdoc">Short-hand for Flow's String_view.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00115">util_fwd.hpp:115</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa455c7f045059736578ca275fc1a851f"><div class="ttname"><a href="namespaceipc.html#aa455c7f045059736578ca275fc1a851f">ipc::Function</a></div><div class="ttdeci">flow::Function&lt; Signature &gt; Function</div><div class="ttdoc">Short-hand for polymorphic functor holder which is very common. This is essentially std::function.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00302">common.hpp:302</a></div></div>
<div class="ttc" id="aprotocol__negotiator_8hpp_html"><div class="ttname"><a href="protocol__negotiator_8hpp.html">protocol_negotiator.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request_html"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html">ipc::transport::sync_io::Native_socket_stream::Impl::Rcv_user_request</a></div><div class="ttdoc">Identical to sync_io::Async_adapter_receiver::User_request, except we only keep at most 1 of these an...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00633">native_socket_stream_impl.hpp:634</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request_html_a589c41dcf6cf1622c8df6a02e1f7497b"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#a589c41dcf6cf1622c8df6a02e1f7497b">ipc::transport::sync_io::Native_socket_stream::Impl::Rcv_user_request::m_target_meta_blob</a></div><div class="ttdeci">util::Blob_mutable m_target_meta_blob</div><div class="ttdoc">Same as in sync_io::Async_adapter_receiver::User_request.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00640">native_socket_stream_impl.hpp:640</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request_html_ae8094bf28837a5ff2f5794222114d3b7"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#ae8094bf28837a5ff2f5794222114d3b7">ipc::transport::sync_io::Native_socket_stream::Impl::Rcv_user_request::m_target_hndl_ptr</a></div><div class="ttdeci">Native_handle * m_target_hndl_ptr</div><div class="ttdoc">Same as in sync_io::Async_adapter_receiver::User_request.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00638">native_socket_stream_impl.hpp:638</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request_html_aefe91c059a20b86e2391bb1b46a38b23"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Rcv__user__request.html#aefe91c059a20b86e2391bb1b46a38b23">ipc::transport::sync_io::Native_socket_stream::Impl::Rcv_user_request::m_on_done_func</a></div><div class="ttdeci">flow::async::Task_asio_err_sz m_on_done_func</div><div class="ttdoc">Same as in sync_io::Async_adapter_receiver::User_request.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00642">native_socket_stream_impl.hpp:642</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload_html"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html">ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload</a></div><div class="ttdoc">Data store representing a payload corresponding to exactly one attempted async write-op,...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00609">native_socket_stream_impl.hpp:610</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload_html_a1896eff734a019cec47970cc081482e8"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a1896eff734a019cec47970cc081482e8">ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload::m_hndl_or_null</a></div><div class="ttdeci">Native_handle m_hndl_or_null</div><div class="ttdoc">The native handle to transmit in the payload; .null() == true to transmit no such thing.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00619">native_socket_stream_impl.hpp:619</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload_html_a2d3a01b00a000c3f40b3d580cd3b1c35"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35">ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload::Ptr</a></div><div class="ttdeci">boost::movelib::unique_ptr&lt; Snd_low_lvl_payload &gt; Ptr</div><div class="ttdoc">Short-hand for unique_ptr to this.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00614">native_socket_stream_impl.hpp:614</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload_html_abd7b83c53f0bc04c6c74315f1bbe09d6"><div class="ttname"><a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#abd7b83c53f0bc04c6c74315f1bbe09d6">ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload::m_blob</a></div><div class="ttdeci">flow::util::Blob m_blob</div><div class="ttdoc">The buffer to transmit in the payload; !m_blob.empty() == true, period.</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00625">native_socket_stream_impl.hpp:625</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
<div class="ttc" id="async__io_2native__socket__stream_8hpp_html"><div class="ttname"><a href="sync__io_2native__socket__stream_8hpp.html">native_socket_stream.hpp</a></div></div>
<div class="ttc" id="async__io__fwd_8hpp_html"><div class="ttname"><a href="sync__io__fwd_8hpp.html">sync_io_fwd.hpp</a></div></div>
<div class="ttc" id="atimer__ev__emitter_8hpp_html"><div class="ttname"><a href="timer__ev__emitter_8hpp.html">timer_ev_emitter.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
